{ "opencollection": "1.0.0", "info": { "name": "The Things Stack — Application Server AppAs ClientRegistry API", "version": "v3.36" }, "items": [ { "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." } ] } ], "bundled": true }