{ "opencollection": "1.0.0", "info": { "name": "The Things Stack — Application Server AppAs ApplicationAccess API", "version": "v3.36" }, "items": [ { "info": { "name": "ApplicationAccess", "type": "folder" }, "items": [ { "info": { "name": "List the API keys for this application.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/applications/:application_ids.application_id/api-keys", "params": [ { "name": "application_ids.application_id", "value": "", "type": "path" }, { "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 application." }, { "info": { "name": "Create an API key scoped to this application.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/applications/:application_ids.application_id/api-keys", "params": [ { "name": "application_ids.application_id", "value": "", "type": "path" } ] }, "docs": "Create an API key scoped to this application." }, { "info": { "name": "Update the rights of an API key of the application.\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}}/applications/:application_ids.application_id/api-keys/:api_key.id", "params": [ { "name": "application_ids.application_id", "value": "", "type": "path" }, { "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 application.\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 application.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/applications/:application_ids.application_id/api-keys/:key_id", "params": [ { "name": "application_ids.application_id", "value": "", "type": "path" }, { "name": "key_id", "value": "", "type": "path", "description": "Unique public identifier for the API key." } ] }, "docs": "Get a single API key of this application." }, { "info": { "name": "Delete a single API key of this application.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/applications/:application_ids.application_id/api-keys/:key_id", "params": [ { "name": "application_ids.application_id", "value": "", "type": "path" }, { "name": "key_id", "value": "", "type": "path" } ] }, "docs": "Delete a single API key of this application." }, { "info": { "name": "Get the rights of a collaborator (member) of the application.\nPseudo-rights in the response (such as the \"_ALL\" right) are not expanded.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/applications/:application_ids.application_id/collaborator/organization/:collaborator.organization_ids.organization_id", "params": [ { "name": "application_ids.application_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 application.\nPseudo-rights in the response (such as the \"_ALL\" right) are not expanded." }, { "info": { "name": "DeleteCollaborator removes a collaborator from an application.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/applications/:application_ids.application_id/collaborator/organization/:collaborator_ids.organization_ids.organization_id", "params": [ { "name": "application_ids.application_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 an application." }, { "info": { "name": "Get the rights of a collaborator (member) of the application.\nPseudo-rights in the response (such as the \"_ALL\" right) are not expanded.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/applications/:application_ids.application_id/collaborator/user/:collaborator.user_ids.user_id", "params": [ { "name": "application_ids.application_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 application.\nPseudo-rights in the response (such as the \"_ALL\" right) are not expanded." }, { "info": { "name": "DeleteCollaborator removes a collaborator from an application.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/applications/:application_ids.application_id/collaborator/user/:collaborator_ids.user_ids.user_id", "params": [ { "name": "application_ids.application_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 an application." }, { "info": { "name": "List the collaborators on this application.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/applications/:application_ids.application_id/collaborators", "params": [ { "name": "application_ids.application_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 application." }, { "info": { "name": "Set the rights of a collaborator (member) on the application.\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}}/applications/:application_ids.application_id/collaborators", "params": [ { "name": "application_ids.application_id", "value": "", "type": "path" } ] }, "docs": "Set the rights of a collaborator (member) on the application.\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": "List the rights the caller has on this application.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/applications/:application_id/rights", "params": [ { "name": "application_id", "value": "", "type": "path" } ] }, "docs": "List the rights the caller has on this application." } ] } ], "bundled": true }