{ "opencollection": "1.0.0", "info": { "name": "The Things Stack — Application Server AppAs EntityRegistrySearch API", "version": "v3.36" }, "items": [ { "info": { "name": "EntityRegistrySearch", "type": "folder" }, "items": [ { "info": { "name": "Search for accounts that match the conditions specified in the request.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/applications/:application_ids.application_id/collaborators/search", "params": [ { "name": "application_ids.application_id", "value": "", "type": "path" }, { "name": "query", "value": "", "type": "query" }, { "name": "only_users", "value": "", "type": "query" }, { "name": "client_ids.client_id", "value": "", "type": "query" }, { "name": "gateway_ids.gateway_id", "value": "", "type": "query" }, { "name": "gateway_ids.eui", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." }, { "name": "organization_ids.organization_id", "value": "", "type": "query", "description": "This ID shares namespace with user IDs." }, { "name": "complement_collaborators", "value": "", "type": "query" } ] }, "docs": "Search for accounts that match the conditions specified in the request." }, { "info": { "name": "Search for accounts that match the conditions specified in the request.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/clients/:client_ids.client_id/collaborators/search", "params": [ { "name": "client_ids.client_id", "value": "", "type": "path" }, { "name": "query", "value": "", "type": "query" }, { "name": "only_users", "value": "", "type": "query" }, { "name": "application_ids.application_id", "value": "", "type": "query" }, { "name": "gateway_ids.gateway_id", "value": "", "type": "query" }, { "name": "gateway_ids.eui", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." }, { "name": "organization_ids.organization_id", "value": "", "type": "query", "description": "This ID shares namespace with user IDs." }, { "name": "complement_collaborators", "value": "", "type": "query" } ] }, "docs": "Search for accounts that match the conditions specified in the request." }, { "info": { "name": "Search for accounts that match the conditions specified in the request.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/gateways/:gateway_ids.gateway_id/collaborators/search", "params": [ { "name": "gateway_ids.gateway_id", "value": "", "type": "path" }, { "name": "query", "value": "", "type": "query" }, { "name": "only_users", "value": "", "type": "query" }, { "name": "application_ids.application_id", "value": "", "type": "query" }, { "name": "client_ids.client_id", "value": "", "type": "query" }, { "name": "gateway_ids.eui", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." }, { "name": "organization_ids.organization_id", "value": "", "type": "query", "description": "This ID shares namespace with user IDs." }, { "name": "complement_collaborators", "value": "", "type": "query" } ] }, "docs": "Search for accounts that match the conditions specified in the request." }, { "info": { "name": "Search for accounts that match the conditions specified in the request.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organizations/:organization_ids.organization_id/collaborators/search", "params": [ { "name": "organization_ids.organization_id", "value": "", "type": "path", "description": "This ID shares namespace with user IDs." }, { "name": "query", "value": "", "type": "query" }, { "name": "only_users", "value": "", "type": "query" }, { "name": "application_ids.application_id", "value": "", "type": "query" }, { "name": "client_ids.client_id", "value": "", "type": "query" }, { "name": "gateway_ids.gateway_id", "value": "", "type": "query" }, { "name": "gateway_ids.eui", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." }, { "name": "complement_collaborators", "value": "", "type": "query" } ] }, "docs": "Search for accounts that match the conditions specified in the request." }, { "info": { "name": "Search for accounts that match the conditions specified in the request.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/search/accounts", "params": [ { "name": "query", "value": "", "type": "query" }, { "name": "only_users", "value": "", "type": "query" }, { "name": "application_ids.application_id", "value": "", "type": "query" }, { "name": "client_ids.client_id", "value": "", "type": "query" }, { "name": "gateway_ids.gateway_id", "value": "", "type": "query" }, { "name": "gateway_ids.eui", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." }, { "name": "organization_ids.organization_id", "value": "", "type": "query", "description": "This ID shares namespace with user IDs." }, { "name": "complement_collaborators", "value": "", "type": "query" } ] }, "docs": "Search for accounts that match the conditions specified in the request." }, { "info": { "name": "Search for applications that match the conditions specified in the request.\nNon-admin users will only match applications that they have rights on.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/search/applications", "params": [ { "name": "query", "value": "", "type": "query", "description": "Find applications where the ID, name or description contains this substring." }, { "name": "id_contains", "value": "", "type": "query", "description": "Find applications where the ID contains this substring." }, { "name": "name_contains", "value": "", "type": "query", "description": "Find applications where the name contains this substring." }, { "name": "description_contains", "value": "", "type": "query", "description": "Find applications where the description contains this substring." }, { "name": "attributes_contain[string]", "value": "", "type": "query", "description": "This is a request variable of the map type. The query format is \"map_name[key]=value\", e.g. If the map name is Age, the key type is string, and the value type is integer, the query parameter is expressed as Age[\"bob\"]=18" }, { "name": "field_mask", "value": "", "type": "query" }, { "name": "order", "value": "", "type": "query", "description": "Order the results by this field path (must be present in the field mask).\nDefault ordering is by ID. Prepend with a minus (-) to reverse the order." }, { "name": "limit", "value": "", "type": "query", "description": "Limit the number of results per page." }, { "name": "page", "value": "", "type": "query", "description": "Page number for pagination. 0 is interpreted as 1." }, { "name": "deleted", "value": "", "type": "query", "description": "Only return recently deleted applications." } ] }, "docs": "Search for applications that match the conditions specified in the request.\nNon-admin users will only match applications that they have rights on." }, { "info": { "name": "Search for OAuth clients that match the conditions specified in the request.\nNon-admin users will only match OAuth clients that they have rights on.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/search/clients", "params": [ { "name": "query", "value": "", "type": "query", "description": "Find OAuth clients where the ID, name or description contains this substring." }, { "name": "id_contains", "value": "", "type": "query", "description": "Find OAuth clients where the ID contains this substring." }, { "name": "name_contains", "value": "", "type": "query", "description": "Find OAuth clients where the name contains this substring." }, { "name": "description_contains", "value": "", "type": "query", "description": "Find OAuth clients where the description contains this substring." }, { "name": "attributes_contain[string]", "value": "", "type": "query", "description": "This is a request variable of the map type. The query format is \"map_name[key]=value\", e.g. If the map name is Age, the key type is string, and the value type is integer, the query parameter is expressed as Age[\"bob\"]=18" }, { "name": "state", "value": "", "type": "query", "description": "Find OAuth clients where the state is any of these states.\n\n - STATE_REQUESTED: Denotes that the entity has been requested and is pending review by an admin.\n - STATE_APPROVED: Denotes that the entity has been reviewed and approved by an admin.\n - STATE_REJECTED: Denotes that the entity has been reviewed and rejected by an admin.\n - STATE_FLAGGED: Denotes that the entity has been flagged and is pending review by an admin.\n - STATE_SUSPENDED: Denotes that the entity has been reviewed and suspended by an admin." }, { "name": "field_mask", "value": "", "type": "query" }, { "name": "order", "value": "", "type": "query", "description": "Order the results by this field path (must be present in the field mask).\nDefault ordering is by ID. Prepend with a minus (-) to reverse the order." }, { "name": "limit", "value": "", "type": "query", "description": "Limit the number of results per page." }, { "name": "page", "value": "", "type": "query", "description": "Page number for pagination. 0 is interpreted as 1." }, { "name": "deleted", "value": "", "type": "query", "description": "Only return recently deleted OAuth clients." } ] }, "docs": "Search for OAuth clients that match the conditions specified in the request.\nNon-admin users will only match OAuth clients that they have rights on." }, { "info": { "name": "Search for gateways that match the conditions specified in the request.\nNon-admin users will only match gateways that they have rights on.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/search/gateways", "params": [ { "name": "query", "value": "", "type": "query", "description": "Find gateways where the ID, name, description or EUI contains this substring." }, { "name": "id_contains", "value": "", "type": "query", "description": "Find gateways where the ID contains this substring." }, { "name": "name_contains", "value": "", "type": "query", "description": "Find gateways where the name contains this substring." }, { "name": "description_contains", "value": "", "type": "query", "description": "Find gateways where the description contains this substring." }, { "name": "attributes_contain[string]", "value": "", "type": "query", "description": "This is a request variable of the map type. The query format is \"map_name[key]=value\", e.g. If the map name is Age, the key type is string, and the value type is integer, the query parameter is expressed as Age[\"bob\"]=18" }, { "name": "eui_contains", "value": "", "type": "query", "description": "Find gateways where the (hexadecimal) EUI contains this substring." }, { "name": "field_mask", "value": "", "type": "query" }, { "name": "order", "value": "", "type": "query", "description": "Order the results by this field path (must be present in the field mask).\nDefault ordering is by ID. Prepend with a minus (-) to reverse the order." }, { "name": "limit", "value": "", "type": "query", "description": "Limit the number of results per page." }, { "name": "page", "value": "", "type": "query", "description": "Page number for pagination. 0 is interpreted as 1." }, { "name": "deleted", "value": "", "type": "query", "description": "Only return recently deleted gateways." } ] }, "docs": "Search for gateways that match the conditions specified in the request.\nNon-admin users will only match gateways that they have rights on." }, { "info": { "name": "Search for organizations that match the conditions specified in the request.\nNon-admin users will only match organizations that they have rights on.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/search/organizations", "params": [ { "name": "query", "value": "", "type": "query", "description": "Find organizations where the ID, name or description contains this substring." }, { "name": "id_contains", "value": "", "type": "query", "description": "Find organizations where the ID contains this substring." }, { "name": "name_contains", "value": "", "type": "query", "description": "Find organizations where the name contains this substring." }, { "name": "description_contains", "value": "", "type": "query", "description": "Find organizations where the description contains this substring." }, { "name": "attributes_contain[string]", "value": "", "type": "query", "description": "This is a request variable of the map type. The query format is \"map_name[key]=value\", e.g. If the map name is Age, the key type is string, and the value type is integer, the query parameter is expressed as Age[\"bob\"]=18" }, { "name": "field_mask", "value": "", "type": "query" }, { "name": "order", "value": "", "type": "query", "description": "Order the results by this field path (must be present in the field mask).\nDefault ordering is by ID. Prepend with a minus (-) to reverse the order." }, { "name": "limit", "value": "", "type": "query", "description": "Limit the number of results per page." }, { "name": "page", "value": "", "type": "query", "description": "Page number for pagination. 0 is interpreted as 1." }, { "name": "deleted", "value": "", "type": "query", "description": "Only return recently deleted organizations." } ] }, "docs": "Search for organizations that match the conditions specified in the request.\nNon-admin users will only match organizations that they have rights on." }, { "info": { "name": "Search for users that match the conditions specified in the request.\nThis is only available to admin users.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/search/users", "params": [ { "name": "query", "value": "", "type": "query", "description": "Find users where the ID, name or description contains this substring." }, { "name": "id_contains", "value": "", "type": "query", "description": "Find users where the ID contains this substring." }, { "name": "name_contains", "value": "", "type": "query", "description": "Find users where the name contains this substring." }, { "name": "description_contains", "value": "", "type": "query", "description": "Find users where the description contains this substring." }, { "name": "attributes_contain[string]", "value": "", "type": "query", "description": "This is a request variable of the map type. The query format is \"map_name[key]=value\", e.g. If the map name is Age, the key type is string, and the value type is integer, the query parameter is expressed as Age[\"bob\"]=18" }, { "name": "state", "value": "", "type": "query", "description": "Find users where the state is any of these states.\n\n - STATE_REQUESTED: Denotes that the entity has been requested and is pending review by an admin.\n - STATE_APPROVED: Denotes that the entity has been reviewed and approved by an admin.\n - STATE_REJECTED: Denotes that the entity has been reviewed and rejected by an admin.\n - STATE_FLAGGED: Denotes that the entity has been flagged and is pending review by an admin.\n - STATE_SUSPENDED: Denotes that the entity has been reviewed and suspended by an admin." }, { "name": "field_mask", "value": "", "type": "query" }, { "name": "order", "value": "", "type": "query", "description": "Order the results by this field path (must be present in the field mask).\nDefault ordering is by ID. Prepend with a minus (-) to reverse the order." }, { "name": "limit", "value": "", "type": "query", "description": "Limit the number of results per page." }, { "name": "page", "value": "", "type": "query", "description": "Page number for pagination. 0 is interpreted as 1." }, { "name": "deleted", "value": "", "type": "query", "description": "Only return recently deleted users." } ] }, "docs": "Search for users that match the conditions specified in the request.\nThis is only available to admin users." } ] } ], "bundled": true }