{ "opencollection": "1.0.0", "info": { "name": "The Things Stack — Identity Server", "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." } ] }, { "info": { "name": "EntityAccess", "type": "folder" }, "items": [ { "info": { "name": "AuthInfo returns information about the authentication that is used on the request.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/auth_info" }, "docs": "AuthInfo returns information about the authentication that is used on the request." } ] }, { "info": { "name": "ClientRegistry", "type": "folder" }, "items": [ { "info": { "name": "List OAuth clients where the given user or organization is a direct collaborator.\nIf no user or organization is given, this returns the OAuth clients the caller\nhas access to.\nSimilar to Get, this selects the fields specified in the field mask.\nMore or less fields may be returned, depending on the rights of the caller.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/clients", "params": [ { "name": "collaborator.organization_ids.organization_id", "value": "", "type": "query", "description": "This ID shares namespace with user IDs." }, { "name": "collaborator.user_ids.user_id", "value": "", "type": "query", "description": "This ID shares namespace with organization IDs." }, { "name": "collaborator.user_ids.email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." }, { "name": "field_mask", "value": "", "type": "query", "description": "The names of the client fields that should be returned." }, { "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 clients." } ] }, "docs": "List OAuth clients where the given user or organization is a direct collaborator.\nIf no user or organization is given, this returns the OAuth clients the caller\nhas access to.\nSimilar to Get, this selects the fields specified in the field mask.\nMore or less fields may be returned, depending on the rights of the caller." }, { "info": { "name": "Update the OAuth client, changing the fields specified by the field mask to the provided values.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/clients/:client.ids.client_id", "params": [ { "name": "client.ids.client_id", "value": "", "type": "path" } ] }, "docs": "Update the OAuth client, changing the fields specified by the field mask to the provided values." }, { "info": { "name": "Get the OAuth client with the given identifiers, selecting the fields specified\nin the field mask.\nMore or less fields may be returned, depending on the rights of the caller.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/clients/:client_ids.client_id", "params": [ { "name": "client_ids.client_id", "value": "", "type": "path" }, { "name": "field_mask", "value": "", "type": "query", "description": "The names of the client fields that should be returned." } ] }, "docs": "Get the OAuth client with the given identifiers, selecting the fields specified\nin the field mask.\nMore or less fields may be returned, depending on the rights of the caller." }, { "info": { "name": "Delete the OAuth client. This may not release the client ID for reuse.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/clients/:client_id", "params": [ { "name": "client_id", "value": "", "type": "path" } ] }, "docs": "Delete the OAuth client. This may not release the client ID for reuse." }, { "info": { "name": "Purge the client. This will release the client ID for reuse.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/clients/:client_id/purge", "params": [ { "name": "client_id", "value": "", "type": "path" } ] }, "docs": "Purge the client. This will release the client ID for reuse." }, { "info": { "name": "Restore a recently deleted client.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/clients/:client_id/restore", "params": [ { "name": "client_id", "value": "", "type": "path" } ] }, "docs": "Deployment configuration may specify if, and for how long after deletion,\nentities can be restored." }, { "info": { "name": "List OAuth clients where the given user or organization is a direct collaborator.\nIf no user or organization is given, this returns the OAuth clients the caller\nhas access to.\nSimilar to Get, this selects the fields specified in the field mask.\nMore or less fields may be returned, depending on the rights of the caller.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organizations/:collaborator.organization_ids.organization_id/clients", "params": [ { "name": "collaborator.organization_ids.organization_id", "value": "", "type": "path", "description": "This ID shares namespace with user IDs." }, { "name": "collaborator.user_ids.user_id", "value": "", "type": "query", "description": "This ID shares namespace with organization IDs." }, { "name": "collaborator.user_ids.email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." }, { "name": "field_mask", "value": "", "type": "query", "description": "The names of the client fields that should be returned." }, { "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 clients." } ] }, "docs": "List OAuth clients where the given user or organization is a direct collaborator.\nIf no user or organization is given, this returns the OAuth clients the caller\nhas access to.\nSimilar to Get, this selects the fields specified in the field mask.\nMore or less fields may be returned, depending on the rights of the caller." }, { "info": { "name": "Create a new OAuth client. This also sets the given organization or user as\nfirst collaborator with all possible rights.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organizations/:collaborator.organization_ids.organization_id/clients", "params": [ { "name": "collaborator.organization_ids.organization_id", "value": "", "type": "path", "description": "This ID shares namespace with user IDs." } ] }, "docs": "Create a new OAuth client. This also sets the given organization or user as\nfirst collaborator with all possible rights." }, { "info": { "name": "List OAuth clients where the given user or organization is a direct collaborator.\nIf no user or organization is given, this returns the OAuth clients the caller\nhas access to.\nSimilar to Get, this selects the fields specified in the field mask.\nMore or less fields may be returned, depending on the rights of the caller.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/users/:collaborator.user_ids.user_id/clients", "params": [ { "name": "collaborator.user_ids.user_id", "value": "", "type": "path", "description": "This ID shares namespace with organization IDs." }, { "name": "collaborator.organization_ids.organization_id", "value": "", "type": "query", "description": "This ID shares namespace with user IDs." }, { "name": "collaborator.user_ids.email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." }, { "name": "field_mask", "value": "", "type": "query", "description": "The names of the client fields that should be returned." }, { "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 clients." } ] }, "docs": "List OAuth clients where the given user or organization is a direct collaborator.\nIf no user or organization is given, this returns the OAuth clients the caller\nhas access to.\nSimilar to Get, this selects the fields specified in the field mask.\nMore or less fields may be returned, depending on the rights of the caller." }, { "info": { "name": "Create a new OAuth client. This also sets the given organization or user as\nfirst collaborator with all possible rights.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/users/:collaborator.user_ids.user_id/clients", "params": [ { "name": "collaborator.user_ids.user_id", "value": "", "type": "path", "description": "This ID shares namespace with organization IDs." } ] }, "docs": "Create a new OAuth client. This also sets the given organization or user as\nfirst collaborator with all possible rights." } ] }, { "info": { "name": "ClientAccess", "type": "folder" }, "items": [ { "info": { "name": "Get the rights of a collaborator (member) of the client.\nPseudo-rights in the response (such as the \"_ALL\" right) are not expanded.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/clients/:client_ids.client_id/collaborator/organization/:collaborator.organization_ids.organization_id", "params": [ { "name": "client_ids.client_id", "value": "", "type": "path" }, { "name": "collaborator.organization_ids.organization_id", "value": "", "type": "path", "description": "This ID shares namespace with user IDs." }, { "name": "collaborator.user_ids.user_id", "value": "", "type": "query", "description": "This ID shares namespace with organization IDs." }, { "name": "collaborator.user_ids.email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." } ] }, "docs": "Get the rights of a collaborator (member) of the client.\nPseudo-rights in the response (such as the \"_ALL\" right) are not expanded." }, { "info": { "name": "Get the rights of a collaborator (member) of the client.\nPseudo-rights in the response (such as the \"_ALL\" right) are not expanded.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/clients/:client_ids.client_id/collaborator/user/:collaborator.user_ids.user_id", "params": [ { "name": "client_ids.client_id", "value": "", "type": "path" }, { "name": "collaborator.user_ids.user_id", "value": "", "type": "path", "description": "This ID shares namespace with organization IDs." }, { "name": "collaborator.organization_ids.organization_id", "value": "", "type": "query", "description": "This ID shares namespace with user IDs." }, { "name": "collaborator.user_ids.email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." } ] }, "docs": "Get the rights of a collaborator (member) of the client.\nPseudo-rights in the response (such as the \"_ALL\" right) are not expanded." }, { "info": { "name": "List the collaborators on this OAuth client.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/clients/:client_ids.client_id/collaborators", "params": [ { "name": "client_ids.client_id", "value": "", "type": "path" }, { "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": "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." } ] }, "docs": "List the collaborators on this OAuth client." }, { "info": { "name": "Set the rights of a collaborator (member) on the OAuth client.\nThis method can also be used to delete the collaborator, by giving them no rights.\nThe caller is required to have all assigned or/and removed rights.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/clients/:client_ids.client_id/collaborators", "params": [ { "name": "client_ids.client_id", "value": "", "type": "path" } ] }, "docs": "Set the rights of a collaborator (member) on the OAuth client.\nThis method can also be used to delete the collaborator, by giving them no rights.\nThe caller is required to have all assigned or/and removed rights." }, { "info": { "name": "DeleteCollaborator removes a collaborator from a client.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/clients/:client_ids.client_id/collaborators/organization/:collaborator_ids.organization_ids.organization_id", "params": [ { "name": "client_ids.client_id", "value": "", "type": "path" }, { "name": "collaborator_ids.organization_ids.organization_id", "value": "", "type": "path", "description": "This ID shares namespace with user IDs." }, { "name": "collaborator_ids.user_ids.user_id", "value": "", "type": "query", "description": "This ID shares namespace with organization IDs." }, { "name": "collaborator_ids.user_ids.email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." } ] }, "docs": "DeleteCollaborator removes a collaborator from a client." }, { "info": { "name": "DeleteCollaborator removes a collaborator from a client.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/clients/:client_ids.client_id/collaborators/user/:collaborator_ids.user_ids.user_id", "params": [ { "name": "client_ids.client_id", "value": "", "type": "path" }, { "name": "collaborator_ids.user_ids.user_id", "value": "", "type": "path", "description": "This ID shares namespace with organization IDs." }, { "name": "collaborator_ids.organization_ids.organization_id", "value": "", "type": "query", "description": "This ID shares namespace with user IDs." }, { "name": "collaborator_ids.user_ids.email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." } ] }, "docs": "DeleteCollaborator removes a collaborator from a client." }, { "info": { "name": "List the rights the caller has on this application.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/clients/:client_id/rights", "params": [ { "name": "client_id", "value": "", "type": "path" } ] }, "docs": "List the rights the caller has on this application." } ] }, { "info": { "name": "Configuration", "type": "folder" }, "items": [ { "info": { "name": "Configuration_ListBands", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/configuration/bands", "params": [ { "name": "band_id", "value": "", "type": "query", "description": "Optional Band ID to filter the results.\nIf unused, all supported Bands are returned." }, { "name": "phy_version", "value": "", "type": "query", "description": "Optional PHY version to filter the results.\nIf unused, all supported versions are returned." } ] } }, { "info": { "name": "Configuration_ListBands2", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/configuration/bands/:band_id", "params": [ { "name": "band_id", "value": "", "type": "path", "description": "Optional Band ID to filter the results.\nIf unused, all supported Bands are returned." }, { "name": "phy_version", "value": "", "type": "query", "description": "Optional PHY version to filter the results.\nIf unused, all supported versions are returned." } ] } }, { "info": { "name": "Configuration_ListBands3", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/configuration/bands/:band_id/:phy_version", "params": [ { "name": "band_id", "value": "", "type": "path", "description": "Optional Band ID to filter the results.\nIf unused, all supported Bands are returned." }, { "name": "phy_version", "value": "", "type": "path", "description": "Optional PHY version to filter the results.\nIf unused, all supported versions are returned." } ] } }, { "info": { "name": "Configuration_ListFrequencyPlans", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/configuration/frequency-plans", "params": [ { "name": "base_frequency", "value": "", "type": "query", "description": "Optional base frequency in MHz for hardware support (433, 470, 868 or 915)" }, { "name": "band_id", "value": "", "type": "query", "description": "Optional Band ID to filter the results." }, { "name": "gateways_only", "value": "", "type": "query", "description": "Optional field to include only gateway related results." } ] } }, { "info": { "name": "Returns a list of supported LoRaWAN PHY Versions for the given Band ID.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/configuration/phy-versions", "params": [ { "name": "band_id", "value": "", "type": "query", "description": "Optional Band ID to filter the results.\nIf unused, all supported Bands and their versions are returned." } ] }, "docs": "Returns a list of supported LoRaWAN PHY Versions for the given Band ID." } ] }, { "info": { "name": "ContactInfoRegistry", "type": "folder" }, "items": [ { "info": { "name": "Request validation for the non-validated contact info for the given entity.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/contact_info/validation" }, "docs": "Request validation for the non-validated contact info for the given entity." }, { "info": { "name": "Validate confirms a contact info validation.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/contact_info/validation" }, "docs": "Validate confirms a contact info validation." } ] }, { "info": { "name": "EmailValidationRegistry", "type": "folder" }, "items": [ { "info": { "name": "Request validation for the non-validated contact info for the given entity.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/email/validation" }, "docs": "Request validation for the non-validated contact info for the given entity." }, { "info": { "name": "Validate confirms a contact info validation.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/email/validation" }, "docs": "Validate confirms a contact info validation." } ] }, { "info": { "name": "UserInvitationRegistry", "type": "folder" }, "items": [ { "info": { "name": "List the invitations the caller has sent.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/invitations", "params": [ { "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." } ] }, "docs": "List the invitations the caller has sent." }, { "info": { "name": "Invite a user to join the network.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/invitations" }, "docs": "Invite a user to join the network." }, { "info": { "name": "Delete (revoke) a user invitation.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/invitations", "params": [ { "name": "email", "value": "", "type": "query" } ] }, "docs": "Delete (revoke) a user invitation." } ] }, { "info": { "name": "Is", "type": "folder" }, "items": [ { "info": { "name": "Get the configuration of the Identity Server. The response is typically used\nto enable or disable features in a user interface.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/is/configuration" }, "docs": "Get the configuration of the Identity Server. The response is typically used\nto enable or disable features in a user interface." } ] }, { "info": { "name": "OrganizationRegistry", "type": "folder" }, "items": [ { "info": { "name": "List organizations where the given user or organization is a direct collaborator.\nIf no user or organization is given, this returns the organizations the caller\nhas access to.\nSimilar to Get, this selects the fields given by the field mask.\nMore or less fields may be returned, depending on the rights of the caller.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organizations", "params": [ { "name": "collaborator.organization_ids.organization_id", "value": "", "type": "query", "description": "This ID shares namespace with user IDs." }, { "name": "collaborator.user_ids.user_id", "value": "", "type": "query", "description": "This ID shares namespace with organization IDs." }, { "name": "collaborator.user_ids.email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." }, { "name": "field_mask", "value": "", "type": "query", "description": "The names of the organization fields that should be returned." }, { "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": "List organizations where the given user or organization is a direct collaborator.\nIf no user or organization is given, this returns the organizations the caller\nhas access to.\nSimilar to Get, this selects the fields given by the field mask.\nMore or less fields may be returned, depending on the rights of the caller." }, { "info": { "name": "Update the organization, changing the fields specified by the field mask to the provided values.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/organizations/:organization.ids.organization_id", "params": [ { "name": "organization.ids.organization_id", "value": "", "type": "path", "description": "This ID shares namespace with user IDs." } ] }, "docs": "Update the organization, changing the fields specified by the field mask to the provided values." }, { "info": { "name": "Get the organization with the given identifiers, selecting the fields specified\nin the field mask.\nMore or less fields may be returned, depending on the rights of the caller.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organizations/:organization_ids.organization_id", "params": [ { "name": "organization_ids.organization_id", "value": "", "type": "path", "description": "This ID shares namespace with user IDs." }, { "name": "field_mask", "value": "", "type": "query", "description": "The names of the organization fields that should be returned." } ] }, "docs": "Get the organization with the given identifiers, selecting the fields specified\nin the field mask.\nMore or less fields may be returned, depending on the rights of the caller." }, { "info": { "name": "Delete the organization. This may not release the organization ID for reuse.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/organizations/:organization_id", "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "This ID shares namespace with user IDs." } ] }, "docs": "Delete the organization. This may not release the organization ID for reuse." }, { "info": { "name": "Purge the organization. This will release the organization ID for reuse.\nThe user is responsible for clearing data from any (external) integrations\nthat may store and expose data by user or organization ID.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/organizations/:organization_id/purge", "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "This ID shares namespace with user IDs." } ] }, "docs": "Purge the organization. This will release the organization ID for reuse.\nThe user is responsible for clearing data from any (external) integrations\nthat may store and expose data by user or organization ID." }, { "info": { "name": "Restore a recently deleted organization.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organizations/:organization_id/restore", "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "This ID shares namespace with user IDs." } ] }, "docs": "Deployment configuration may specify if, and for how long after deletion,\nentities can be restored." }, { "info": { "name": "List organizations where the given user or organization is a direct collaborator.\nIf no user or organization is given, this returns the organizations the caller\nhas access to.\nSimilar to Get, this selects the fields given by the field mask.\nMore or less fields may be returned, depending on the rights of the caller.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/users/:collaborator.user_ids.user_id/organizations", "params": [ { "name": "collaborator.user_ids.user_id", "value": "", "type": "path", "description": "This ID shares namespace with organization IDs." }, { "name": "collaborator.organization_ids.organization_id", "value": "", "type": "query", "description": "This ID shares namespace with user IDs." }, { "name": "collaborator.user_ids.email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." }, { "name": "field_mask", "value": "", "type": "query", "description": "The names of the organization fields that should be returned." }, { "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": "List organizations where the given user or organization is a direct collaborator.\nIf no user or organization is given, this returns the organizations the caller\nhas access to.\nSimilar to Get, this selects the fields given by the field mask.\nMore or less fields may be returned, depending on the rights of the caller." }, { "info": { "name": "Create a new organization. This also sets the given user as\nfirst collaborator with all possible rights.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/users/:collaborator.user_ids.user_id/organizations", "params": [ { "name": "collaborator.user_ids.user_id", "value": "", "type": "path", "description": "This ID shares namespace with organization IDs." } ] }, "docs": "Create a new organization. This also sets the given user as\nfirst collaborator with all possible rights." } ] }, { "info": { "name": "OrganizationAccess", "type": "folder" }, "items": [ { "info": { "name": "List the API keys for this organization.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organizations/:organization_ids.organization_id/api-keys", "params": [ { "name": "organization_ids.organization_id", "value": "", "type": "path", "description": "This ID shares namespace with user IDs." }, { "name": "order", "value": "", "type": "query", "description": "Order the results by this field path.\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." } ] }, "docs": "List the API keys for this organization." }, { "info": { "name": "Create an API key scoped to this organization.\nOrganization API keys can give access to the organization itself, as well as\nany application, gateway and OAuth client this organization is a collaborator of.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organizations/:organization_ids.organization_id/api-keys", "params": [ { "name": "organization_ids.organization_id", "value": "", "type": "path", "description": "This ID shares namespace with user IDs." } ] }, "docs": "Create an API key scoped to this organization.\nOrganization API keys can give access to the organization itself, as well as\nany application, gateway and OAuth client this organization is a collaborator of." }, { "info": { "name": "Update the rights of an API key of the organization.\nThis method can also be used to delete the API key, by giving it no rights.\nThe caller is required to have all assigned or/and removed rights.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/organizations/:organization_ids.organization_id/api-keys/:api_key.id", "params": [ { "name": "organization_ids.organization_id", "value": "", "type": "path", "description": "This ID shares namespace with user IDs." }, { "name": "api_key.id", "value": "", "type": "path", "description": "Immutable and unique public identifier for the API key.\nGenerated by the Access Server." } ] }, "docs": "Update the rights of an API key of the organization.\nThis method can also be used to delete the API key, by giving it no rights.\nThe caller is required to have all assigned or/and removed rights." }, { "info": { "name": "Get a single API key of this organization.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organizations/:organization_ids.organization_id/api-keys/:key_id", "params": [ { "name": "organization_ids.organization_id", "value": "", "type": "path", "description": "This ID shares namespace with user IDs." }, { "name": "key_id", "value": "", "type": "path", "description": "Unique public identifier for the API key." } ] }, "docs": "Get a single API key of this organization." }, { "info": { "name": "Delete a single API key of this organization.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/organizations/:organization_ids.organization_id/api-keys/:key_id", "params": [ { "name": "organization_ids.organization_id", "value": "", "type": "path", "description": "This ID shares namespace with user IDs." }, { "name": "key_id", "value": "", "type": "path" } ] }, "docs": "Delete a single API key of this organization." }, { "info": { "name": "Get the rights of a collaborator (member) of the organization.\nPseudo-rights in the response (such as the \"_ALL\" right) are not expanded.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organizations/:organization_ids.organization_id/collaborator/user/:collaborator.user_ids.user_id", "params": [ { "name": "organization_ids.organization_id", "value": "", "type": "path", "description": "This ID shares namespace with user IDs." }, { "name": "collaborator.user_ids.user_id", "value": "", "type": "path", "description": "This ID shares namespace with organization IDs." }, { "name": "collaborator.user_ids.email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." } ] }, "docs": "Get the rights of a collaborator (member) of the organization.\nPseudo-rights in the response (such as the \"_ALL\" right) are not expanded." }, { "info": { "name": "List the collaborators on this organization.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organizations/:organization_ids.organization_id/collaborators", "params": [ { "name": "organization_ids.organization_id", "value": "", "type": "path", "description": "This ID shares namespace with user IDs." }, { "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": "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." } ] }, "docs": "List the collaborators on this organization." }, { "info": { "name": "Set the rights of a collaborator (member) on the organization.\nOrganization collaborators can get access to the organization itself, as well as\nany application, gateway and OAuth client this organization is a collaborator of.\nThis method can also be used to delete the collaborator, by giving them no rights.\nThe caller is required to have all assigned or/and removed rights.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/organizations/:organization_ids.organization_id/collaborators", "params": [ { "name": "organization_ids.organization_id", "value": "", "type": "path", "description": "This ID shares namespace with user IDs." } ] }, "docs": "Set the rights of a collaborator (member) on the organization.\nOrganization collaborators can get access to the organization itself, as well as\nany application, gateway and OAuth client this organization is a collaborator of.\nThis method can also be used to delete the collaborator, by giving them no rights.\nThe caller is required to have all assigned or/and removed rights." }, { "info": { "name": "DeleteCollaborator removes a collaborator from an organization.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/organizations/:organization_ids.organization_id/collaborators/user/:collaborator_ids.user_ids.user_id", "params": [ { "name": "organization_ids.organization_id", "value": "", "type": "path", "description": "This ID shares namespace with user IDs." }, { "name": "collaborator_ids.user_ids.user_id", "value": "", "type": "path", "description": "This ID shares namespace with organization IDs." }, { "name": "collaborator_ids.user_ids.email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." } ] }, "docs": "DeleteCollaborator removes a collaborator from an organization." }, { "info": { "name": "List the rights the caller has on this organization.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organizations/:organization_id/rights", "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "This ID shares namespace with user IDs." } ] }, "docs": "List the rights the caller has on this organization." } ] }, { "info": { "name": "EndDeviceRegistrySearch", "type": "folder" }, "items": [ { "info": { "name": "Search for end devices in the given application that match the conditions specified in the request.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/search/applications/:application_ids.application_id/devices", "params": [ { "name": "application_ids.application_id", "value": "", "type": "path" }, { "name": "query", "value": "", "type": "query", "description": "Find end devices where the ID, name, description or EUI contains this substring." }, { "name": "id_contains", "value": "", "type": "query", "description": "Find end devices where the ID contains this substring." }, { "name": "name_contains", "value": "", "type": "query", "description": "Find end devices where the name contains this substring." }, { "name": "description_contains", "value": "", "type": "query", "description": "Find end devices 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": "dev_eui_contains", "value": "", "type": "query", "description": "Find end devices where the (hexadecimal) DevEUI contains this substring." }, { "name": "join_eui_contains", "value": "", "type": "query", "description": "Find end devices where the (hexadecimal) JoinEUI contains this substring." }, { "name": "dev_addr_contains", "value": "", "type": "query", "description": "Find end devices where the (hexadecimal) DevAddr 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." } ] }, "docs": "Search for end devices in the given application that match the conditions specified in the request." } ] }, { "info": { "name": "UserRegistry", "type": "folder" }, "items": [ { "info": { "name": "List users of the network. This method is typically restricted to admins only.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/users", "params": [ { "name": "field_mask", "value": "", "type": "query", "description": "The names of the user fields that should be returned." }, { "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": "List users of the network. This method is typically restricted to admins only." }, { "info": { "name": "Register a new user. This method may be restricted by network settings.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/users" }, "docs": "Register a new user. This method may be restricted by network settings." }, { "info": { "name": "Update the user, changing the fields specified by the field mask to the provided values.\nThis method can not be used to change the password, see the UpdatePassword method for that.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/users/:user.ids.user_id", "params": [ { "name": "user.ids.user_id", "value": "", "type": "path", "description": "This ID shares namespace with organization IDs." } ] }, "docs": "Update the user, changing the fields specified by the field mask to the provided values.\nThis method can not be used to change the password, see the UpdatePassword method for that." }, { "info": { "name": "Get the user with the given identifiers, selecting the fields given by the\nfield mask. The method may return more or less fields, depending on the rights\nof the caller.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/users/:user_ids.user_id", "params": [ { "name": "user_ids.user_id", "value": "", "type": "path", "description": "This ID shares namespace with organization IDs." }, { "name": "user_ids.email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." }, { "name": "field_mask", "value": "", "type": "query", "description": "The names of the user fields that should be returned." } ] }, "docs": "Get the user with the given identifiers, selecting the fields given by the\nfield mask. The method may return more or less fields, depending on the rights\nof the caller." }, { "info": { "name": "Update the password of the user.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/users/:user_ids.user_id/password", "params": [ { "name": "user_ids.user_id", "value": "", "type": "path", "description": "This ID shares namespace with organization IDs." } ] }, "docs": "Update the password of the user." }, { "info": { "name": "Create a temporary password that can be used for updating a forgotten password.\nThe generated password is sent to the user's email address.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/users/:user_ids.user_id/temporary_password", "params": [ { "name": "user_ids.user_id", "value": "", "type": "path", "description": "This ID shares namespace with organization IDs." }, { "name": "user_ids.email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." } ] }, "docs": "Create a temporary password that can be used for updating a forgotten password.\nThe generated password is sent to the user's email address." }, { "info": { "name": "Delete the user. This may not release the user ID for reuse.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/users/:user_id", "params": [ { "name": "user_id", "value": "", "type": "path", "description": "This ID shares namespace with organization IDs." }, { "name": "email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." } ] }, "docs": "Delete the user. This may not release the user ID for reuse." }, { "info": { "name": "Purge the user. This will release the user ID for reuse.\nThe user is responsible for clearing data from any (external) integrations\nthat may store and expose data by user or organization ID.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/users/:user_id/purge", "params": [ { "name": "user_id", "value": "", "type": "path", "description": "This ID shares namespace with organization IDs." }, { "name": "email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." } ] }, "docs": "Purge the user. This will release the user ID for reuse.\nThe user is responsible for clearing data from any (external) integrations\nthat may store and expose data by user or organization ID." }, { "info": { "name": "Restore a recently deleted user.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/users/:user_id/restore", "params": [ { "name": "user_id", "value": "", "type": "path", "description": "This ID shares namespace with organization IDs." }, { "name": "email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." } ] }, "docs": "Deployment configuration may specify if, and for how long after deletion,\nentities can be restored." } ] }, { "info": { "name": "NotificationService", "type": "folder" }, "items": [ { "info": { "name": "List the notifications for a user or an organization.\nWhen called with user credentials and empty receiver_ids, this will list\nnotifications for the current user and its organizations.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/users/:receiver_ids.user_id/notifications", "params": [ { "name": "receiver_ids.user_id", "value": "", "type": "path", "description": "This ID shares namespace with organization IDs." }, { "name": "receiver_ids.email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." }, { "name": "status", "value": "", "type": "query", "description": "Select notifications with these statuses.\nAn empty list is interpreted as \"all\"." }, { "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." } ] }, "docs": "List the notifications for a user or an organization.\nWhen called with user credentials and empty receiver_ids, this will list\nnotifications for the current user and its organizations." }, { "info": { "name": "Batch-update multiple notifications to the same status.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/users/:receiver_ids.user_id/notifications", "params": [ { "name": "receiver_ids.user_id", "value": "", "type": "path", "description": "This ID shares namespace with organization IDs." } ] }, "docs": "Batch-update multiple notifications to the same status." } ] }, { "info": { "name": "UserAccess", "type": "folder" }, "items": [ { "info": { "name": "List the API keys for this user.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/users/:user_ids.user_id/api-keys", "params": [ { "name": "user_ids.user_id", "value": "", "type": "path", "description": "This ID shares namespace with organization IDs." }, { "name": "user_ids.email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." }, { "name": "order", "value": "", "type": "query", "description": "Order the results by this field path.\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." } ] }, "docs": "List the API keys for this user." }, { "info": { "name": "Create an API key scoped to this user.\nUser API keys can give access to the user itself, as well as\nany organization, application, gateway and OAuth client this user is a collaborator of.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/users/:user_ids.user_id/api-keys", "params": [ { "name": "user_ids.user_id", "value": "", "type": "path", "description": "This ID shares namespace with organization IDs." } ] }, "docs": "Create an API key scoped to this user.\nUser API keys can give access to the user itself, as well as\nany organization, application, gateway and OAuth client this user is a collaborator of." }, { "info": { "name": "Update the rights of an API key of the user.\nThis method can also be used to delete the API key, by giving it no rights.\nThe caller is required to have all assigned or/and removed rights.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/users/:user_ids.user_id/api-keys/:api_key.id", "params": [ { "name": "user_ids.user_id", "value": "", "type": "path", "description": "This ID shares namespace with organization IDs." }, { "name": "api_key.id", "value": "", "type": "path", "description": "Immutable and unique public identifier for the API key.\nGenerated by the Access Server." } ] }, "docs": "Update the rights of an API key of the user.\nThis method can also be used to delete the API key, by giving it no rights.\nThe caller is required to have all assigned or/and removed rights." }, { "info": { "name": "Get a single API key of this user.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/users/:user_ids.user_id/api-keys/:key_id", "params": [ { "name": "user_ids.user_id", "value": "", "type": "path", "description": "This ID shares namespace with organization IDs." }, { "name": "key_id", "value": "", "type": "path", "description": "Unique public identifier for the API key." }, { "name": "user_ids.email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." } ] }, "docs": "Get a single API key of this user." }, { "info": { "name": "Delete a single API key of this user.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/users/:user_ids.user_id/api-keys/:key_id", "params": [ { "name": "user_ids.user_id", "value": "", "type": "path", "description": "This ID shares namespace with organization IDs." }, { "name": "key_id", "value": "", "type": "path" }, { "name": "user_ids.email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." } ] }, "docs": "Delete a single API key of this user." }, { "info": { "name": "Create a login token that can be used for a one-time login as a user.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/users/:user_ids.user_id/login-tokens", "params": [ { "name": "user_ids.user_id", "value": "", "type": "path", "description": "This ID shares namespace with organization IDs." }, { "name": "user_ids.email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." }, { "name": "skip_email", "value": "", "type": "query", "description": "Skip sending the login token to the user by email.\nThis field is only effective when the login token is created by an admin user." } ] }, "docs": "Create a login token that can be used for a one-time login as a user." }, { "info": { "name": "List the rights the caller has on this user.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/users/:user_id/rights", "params": [ { "name": "user_id", "value": "", "type": "path", "description": "This ID shares namespace with organization IDs." }, { "name": "email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." } ] }, "docs": "List the rights the caller has on this user." } ] }, { "info": { "name": "OAuthAuthorizationRegistry", "type": "folder" }, "items": [ { "info": { "name": "List OAuth clients that are authorized by the user.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/users/:user_ids.user_id/authorizations", "params": [ { "name": "user_ids.user_id", "value": "", "type": "path", "description": "This ID shares namespace with organization IDs." }, { "name": "user_ids.email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." }, { "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." } ] }, "docs": "List OAuth clients that are authorized by the user." }, { "info": { "name": "Delete (de-authorize) an OAuth client for the user.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/users/:user_ids.user_id/authorizations/:client_ids.client_id", "params": [ { "name": "user_ids.user_id", "value": "", "type": "path", "description": "This ID shares namespace with organization IDs." }, { "name": "client_ids.client_id", "value": "", "type": "path" }, { "name": "user_ids.email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." } ] }, "docs": "Delete (de-authorize) an OAuth client for the user." }, { "info": { "name": "List OAuth access tokens issued to the OAuth client on behalf of the user.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/users/:user_ids.user_id/authorizations/:client_ids.client_id/tokens", "params": [ { "name": "user_ids.user_id", "value": "", "type": "path", "description": "This ID shares namespace with organization IDs." }, { "name": "client_ids.client_id", "value": "", "type": "path" }, { "name": "user_ids.email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." }, { "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." } ] }, "docs": "List OAuth access tokens issued to the OAuth client on behalf of the user." }, { "info": { "name": "Delete (invalidate) an OAuth access token.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/users/:user_ids.user_id/authorizations/:client_ids.client_id/tokens/:id", "params": [ { "name": "user_ids.user_id", "value": "", "type": "path", "description": "This ID shares namespace with organization IDs." }, { "name": "client_ids.client_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" }, { "name": "user_ids.email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." } ] }, "docs": "Delete (invalidate) an OAuth access token." } ] }, { "info": { "name": "UserBookmarkRegistry", "type": "folder" }, "items": [ { "info": { "name": "List the bookmarks for the given user.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/users/:user_ids.user_id/bookmarks", "params": [ { "name": "user_ids.user_id", "value": "", "type": "path", "description": "This ID shares namespace with organization IDs." }, { "name": "user_ids.email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." }, { "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": "order", "value": "", "type": "query", "description": "Order the results by this field path.\nDefault ordering is by ID. Prepend with a minus (-) to reverse the order." }, { "name": "deleted", "value": "", "type": "query", "description": "Only return recently deleted bookmarks." }, { "name": "entity_types", "value": "", "type": "query", "description": "Specifies that only bookmarks that reference the given entity type should be returned. If empty the filter is not\napplied." } ] }, "docs": "List the bookmarks for the given user." }, { "info": { "name": "Create a bookmark for the given user.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/users/:user_ids.user_id/bookmarks", "params": [ { "name": "user_ids.user_id", "value": "", "type": "path", "description": "This ID shares namespace with organization IDs." } ] }, "docs": "Create a bookmark for the given user." }, { "info": { "name": "Delete the given user's bookmark.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/users/:user_ids.user_id/bookmarks/applications/:entity_ids.application_ids.application_id", "params": [ { "name": "user_ids.user_id", "value": "", "type": "path", "description": "This ID shares namespace with organization IDs." }, { "name": "entity_ids.application_ids.application_id", "value": "", "type": "path" }, { "name": "user_ids.email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." }, { "name": "entity_ids.client_ids.client_id", "value": "", "type": "query" }, { "name": "entity_ids.device_ids.device_id", "value": "", "type": "query" }, { "name": "entity_ids.device_ids.dev_eui", "value": "", "type": "query", "description": "The LoRaWAN DevEUI." }, { "name": "entity_ids.device_ids.join_eui", "value": "", "type": "query", "description": "The LoRaWAN JoinEUI (AppEUI until LoRaWAN 1.0.3 end devices)." }, { "name": "entity_ids.device_ids.dev_addr", "value": "", "type": "query", "description": "The LoRaWAN DevAddr." }, { "name": "entity_ids.gateway_ids.gateway_id", "value": "", "type": "query" }, { "name": "entity_ids.gateway_ids.eui", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." }, { "name": "entity_ids.organization_ids.organization_id", "value": "", "type": "query", "description": "This ID shares namespace with user IDs." }, { "name": "entity_ids.user_ids.email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." } ] }, "docs": "Delete the given user's bookmark." }, { "info": { "name": "Delete the given user's bookmark.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/users/:user_ids.user_id/bookmarks/applications/:entity_ids.device_ids.application_ids.application_id/devices/:entity_ids.device_ids.device_id", "params": [ { "name": "user_ids.user_id", "value": "", "type": "path", "description": "This ID shares namespace with organization IDs." }, { "name": "entity_ids.device_ids.application_ids.application_id", "value": "", "type": "path" }, { "name": "entity_ids.device_ids.device_id", "value": "", "type": "path" }, { "name": "user_ids.email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." }, { "name": "entity_ids.client_ids.client_id", "value": "", "type": "query" }, { "name": "entity_ids.device_ids.dev_eui", "value": "", "type": "query", "description": "The LoRaWAN DevEUI." }, { "name": "entity_ids.device_ids.join_eui", "value": "", "type": "query", "description": "The LoRaWAN JoinEUI (AppEUI until LoRaWAN 1.0.3 end devices)." }, { "name": "entity_ids.device_ids.dev_addr", "value": "", "type": "query", "description": "The LoRaWAN DevAddr." }, { "name": "entity_ids.gateway_ids.gateway_id", "value": "", "type": "query" }, { "name": "entity_ids.gateway_ids.eui", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." }, { "name": "entity_ids.organization_ids.organization_id", "value": "", "type": "query", "description": "This ID shares namespace with user IDs." }, { "name": "entity_ids.user_ids.email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." } ] }, "docs": "Delete the given user's bookmark." }, { "info": { "name": "Delete a list of bookmarks of the given user.\nThis operation is atomic; either all bookmarks are deleted or none.\nBookmarks not found are skipped and no error is returned.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/users/:user_ids.user_id/bookmarks/batch", "params": [ { "name": "user_ids.user_id", "value": "", "type": "path", "description": "This ID shares namespace with organization IDs." }, { "name": "user_ids.email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." } ] }, "docs": "Delete a list of bookmarks of the given user.\nThis operation is atomic; either all bookmarks are deleted or none.\nBookmarks not found are skipped and no error is returned." }, { "info": { "name": "Delete the given user's bookmark.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/users/:user_ids.user_id/bookmarks/clients/:entity_ids.client_ids.client_id", "params": [ { "name": "user_ids.user_id", "value": "", "type": "path", "description": "This ID shares namespace with organization IDs." }, { "name": "entity_ids.client_ids.client_id", "value": "", "type": "path" }, { "name": "user_ids.email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." }, { "name": "entity_ids.application_ids.application_id", "value": "", "type": "query" }, { "name": "entity_ids.device_ids.device_id", "value": "", "type": "query" }, { "name": "entity_ids.device_ids.application_ids.application_id", "value": "", "type": "query" }, { "name": "entity_ids.device_ids.dev_eui", "value": "", "type": "query", "description": "The LoRaWAN DevEUI." }, { "name": "entity_ids.device_ids.join_eui", "value": "", "type": "query", "description": "The LoRaWAN JoinEUI (AppEUI until LoRaWAN 1.0.3 end devices)." }, { "name": "entity_ids.device_ids.dev_addr", "value": "", "type": "query", "description": "The LoRaWAN DevAddr." }, { "name": "entity_ids.gateway_ids.gateway_id", "value": "", "type": "query" }, { "name": "entity_ids.gateway_ids.eui", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." }, { "name": "entity_ids.organization_ids.organization_id", "value": "", "type": "query", "description": "This ID shares namespace with user IDs." }, { "name": "entity_ids.user_ids.email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." } ] }, "docs": "Delete the given user's bookmark." }, { "info": { "name": "Delete the given user's bookmark.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/users/:user_ids.user_id/bookmarks/gateways/:entity_ids.gateway_ids.gateway_id", "params": [ { "name": "user_ids.user_id", "value": "", "type": "path", "description": "This ID shares namespace with organization IDs." }, { "name": "entity_ids.gateway_ids.gateway_id", "value": "", "type": "path" }, { "name": "user_ids.email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." }, { "name": "entity_ids.application_ids.application_id", "value": "", "type": "query" }, { "name": "entity_ids.client_ids.client_id", "value": "", "type": "query" }, { "name": "entity_ids.device_ids.device_id", "value": "", "type": "query" }, { "name": "entity_ids.device_ids.application_ids.application_id", "value": "", "type": "query" }, { "name": "entity_ids.device_ids.dev_eui", "value": "", "type": "query", "description": "The LoRaWAN DevEUI." }, { "name": "entity_ids.device_ids.join_eui", "value": "", "type": "query", "description": "The LoRaWAN JoinEUI (AppEUI until LoRaWAN 1.0.3 end devices)." }, { "name": "entity_ids.device_ids.dev_addr", "value": "", "type": "query", "description": "The LoRaWAN DevAddr." }, { "name": "entity_ids.gateway_ids.eui", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." }, { "name": "entity_ids.organization_ids.organization_id", "value": "", "type": "query", "description": "This ID shares namespace with user IDs." }, { "name": "entity_ids.user_ids.email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." } ] }, "docs": "Delete the given user's bookmark." }, { "info": { "name": "Delete the given user's bookmark.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/users/:user_ids.user_id/bookmarks/organizations/:entity_ids.organization_ids.organization_id", "params": [ { "name": "user_ids.user_id", "value": "", "type": "path", "description": "This ID shares namespace with organization IDs." }, { "name": "entity_ids.organization_ids.organization_id", "value": "", "type": "path", "description": "This ID shares namespace with user IDs." }, { "name": "user_ids.email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." }, { "name": "entity_ids.application_ids.application_id", "value": "", "type": "query" }, { "name": "entity_ids.client_ids.client_id", "value": "", "type": "query" }, { "name": "entity_ids.device_ids.device_id", "value": "", "type": "query" }, { "name": "entity_ids.device_ids.application_ids.application_id", "value": "", "type": "query" }, { "name": "entity_ids.device_ids.dev_eui", "value": "", "type": "query", "description": "The LoRaWAN DevEUI." }, { "name": "entity_ids.device_ids.join_eui", "value": "", "type": "query", "description": "The LoRaWAN JoinEUI (AppEUI until LoRaWAN 1.0.3 end devices)." }, { "name": "entity_ids.device_ids.dev_addr", "value": "", "type": "query", "description": "The LoRaWAN DevAddr." }, { "name": "entity_ids.gateway_ids.gateway_id", "value": "", "type": "query" }, { "name": "entity_ids.gateway_ids.eui", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." }, { "name": "entity_ids.user_ids.email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." } ] }, "docs": "Delete the given user's bookmark." }, { "info": { "name": "Delete the given user's bookmark.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/users/:user_ids.user_id/bookmarks/users/:entity_ids.user_ids.user_id", "params": [ { "name": "user_ids.user_id", "value": "", "type": "path", "description": "This ID shares namespace with organization IDs." }, { "name": "entity_ids.user_ids.user_id", "value": "", "type": "path", "description": "This ID shares namespace with organization IDs." }, { "name": "user_ids.email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." }, { "name": "entity_ids.application_ids.application_id", "value": "", "type": "query" }, { "name": "entity_ids.client_ids.client_id", "value": "", "type": "query" }, { "name": "entity_ids.device_ids.device_id", "value": "", "type": "query" }, { "name": "entity_ids.device_ids.application_ids.application_id", "value": "", "type": "query" }, { "name": "entity_ids.device_ids.dev_eui", "value": "", "type": "query", "description": "The LoRaWAN DevEUI." }, { "name": "entity_ids.device_ids.join_eui", "value": "", "type": "query", "description": "The LoRaWAN JoinEUI (AppEUI until LoRaWAN 1.0.3 end devices)." }, { "name": "entity_ids.device_ids.dev_addr", "value": "", "type": "query", "description": "The LoRaWAN DevAddr." }, { "name": "entity_ids.gateway_ids.gateway_id", "value": "", "type": "query" }, { "name": "entity_ids.gateway_ids.eui", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." }, { "name": "entity_ids.organization_ids.organization_id", "value": "", "type": "query", "description": "This ID shares namespace with user IDs." }, { "name": "entity_ids.user_ids.email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." } ] }, "docs": "Delete the given user's bookmark." } ] }, { "info": { "name": "UserSessionRegistry", "type": "folder" }, "items": [ { "info": { "name": "List the active sessions for the given user.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/users/:user_ids.user_id/sessions", "params": [ { "name": "user_ids.user_id", "value": "", "type": "path", "description": "This ID shares namespace with organization IDs." }, { "name": "user_ids.email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." }, { "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." } ] }, "docs": "List the active sessions for the given user." }, { "info": { "name": "Delete (revoke) the given user session.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/users/:user_ids.user_id/sessions/:session_id", "params": [ { "name": "user_ids.user_id", "value": "", "type": "path", "description": "This ID shares namespace with organization IDs." }, { "name": "session_id", "value": "", "type": "path" }, { "name": "user_ids.email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." } ] }, "docs": "Delete (revoke) the given user session." } ] } ], "bundled": true }