{ "opencollection": "1.0.0", "info": { "name": "The Things Stack — Application Server AppAs GatewayAccess API", "version": "v3.36" }, "items": [ { "info": { "name": "GatewayAccess", "type": "folder" }, "items": [ { "info": { "name": "List the API keys for this gateway.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/gateways/:gateway_ids.gateway_id/api-keys", "params": [ { "name": "gateway_ids.gateway_id", "value": "", "type": "path" }, { "name": "gateway_ids.eui", "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 gateway." }, { "info": { "name": "Create an API key scoped to this gateway.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/gateways/:gateway_ids.gateway_id/api-keys", "params": [ { "name": "gateway_ids.gateway_id", "value": "", "type": "path" } ] }, "docs": "Create an API key scoped to this gateway." }, { "info": { "name": "Update the rights of an API key of the gateway.\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}}/gateways/:gateway_ids.gateway_id/api-keys/:api_key.id", "params": [ { "name": "gateway_ids.gateway_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 gateway.\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 gateway.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/gateways/:gateway_ids.gateway_id/api-keys/:key_id", "params": [ { "name": "gateway_ids.gateway_id", "value": "", "type": "path" }, { "name": "key_id", "value": "", "type": "path", "description": "Unique public identifier for the API key." }, { "name": "gateway_ids.eui", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." } ] }, "docs": "Get a single API key of this gateway." }, { "info": { "name": "Delete a single API key of this gateway.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/gateways/:gateway_ids.gateway_id/api-keys/:key_id", "params": [ { "name": "gateway_ids.gateway_id", "value": "", "type": "path" }, { "name": "key_id", "value": "", "type": "path" }, { "name": "gateway_ids.eui", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." } ] }, "docs": "Delete a single API key of this gateway." }, { "info": { "name": "Get the rights of a collaborator (member) of the gateway.\nPseudo-rights in the response (such as the \"_ALL\" right) are not expanded.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/gateways/:gateway_ids.gateway_id/collaborator/organization/:collaborator.organization_ids.organization_id", "params": [ { "name": "gateway_ids.gateway_id", "value": "", "type": "path" }, { "name": "collaborator.organization_ids.organization_id", "value": "", "type": "path", "description": "This ID shares namespace with user IDs." }, { "name": "gateway_ids.eui", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." }, { "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 gateway.\nPseudo-rights in the response (such as the \"_ALL\" right) are not expanded." }, { "info": { "name": "Get the rights of a collaborator (member) of the gateway.\nPseudo-rights in the response (such as the \"_ALL\" right) are not expanded.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/gateways/:gateway_ids.gateway_id/collaborator/user/:collaborator.user_ids.user_id", "params": [ { "name": "gateway_ids.gateway_id", "value": "", "type": "path" }, { "name": "collaborator.user_ids.user_id", "value": "", "type": "path", "description": "This ID shares namespace with organization IDs." }, { "name": "gateway_ids.eui", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." }, { "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 gateway.\nPseudo-rights in the response (such as the \"_ALL\" right) are not expanded." }, { "info": { "name": "List the collaborators on this gateway.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/gateways/:gateway_ids.gateway_id/collaborators", "params": [ { "name": "gateway_ids.gateway_id", "value": "", "type": "path" }, { "name": "gateway_ids.eui", "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 (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 gateway." }, { "info": { "name": "Set the rights of a collaborator (member) on the gateway.\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}}/gateways/:gateway_ids.gateway_id/collaborators", "params": [ { "name": "gateway_ids.gateway_id", "value": "", "type": "path" } ] }, "docs": "Set the rights of a collaborator (member) on the gateway.\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 gateway.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/gateways/:gateway_ids.gateway_id/collaborators/organization/:collaborator_ids.organization_ids.organization_id", "params": [ { "name": "gateway_ids.gateway_id", "value": "", "type": "path" }, { "name": "collaborator_ids.organization_ids.organization_id", "value": "", "type": "path", "description": "This ID shares namespace with user IDs." }, { "name": "gateway_ids.eui", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." }, { "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 gateway." }, { "info": { "name": "DeleteCollaborator removes a collaborator from a gateway.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/gateways/:gateway_ids.gateway_id/collaborators/user/:collaborator_ids.user_ids.user_id", "params": [ { "name": "gateway_ids.gateway_id", "value": "", "type": "path" }, { "name": "collaborator_ids.user_ids.user_id", "value": "", "type": "path", "description": "This ID shares namespace with organization IDs." }, { "name": "gateway_ids.eui", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." }, { "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 gateway." }, { "info": { "name": "List the rights the caller has on this gateway.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/gateways/:gateway_id/rights", "params": [ { "name": "gateway_id", "value": "", "type": "path" }, { "name": "eui", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." } ] }, "docs": "List the rights the caller has on this gateway." } ] } ], "bundled": true }