{ "opencollection": "1.0.0", "info": { "name": "SlashID Groups Organization External Credentials API", "version": "1.1" }, "request": { "auth": { "type": "apikey", "key": "SlashID-API-Key", "value": "{{SlashID-API-Key}}", "placement": "header" } }, "items": [ { "info": { "name": "Organization External Credentials", "type": "folder" }, "items": [ { "info": { "name": "List available external credentials", "type": "http" }, "http": { "method": "GET", "url": "https://api.slashid.com/organizations/config/external-credentials", "headers": [ { "name": "SlashID-OrgID", "value": "af5fbd30-7ce7-4548-8b30-4cd59cb2aba1" } ] }, "docs": "Lists the all available external credentials for third party services. The call doesn't return any key material, credential IDs can be used to retrieve the credential.\n" }, { "info": { "name": "Create a new set of external credentials", "type": "http" }, "http": { "method": "POST", "url": "https://api.slashid.com/organizations/config/external-credentials", "headers": [ { "name": "SlashID-OrgID", "value": "af5fbd30-7ce7-4548-8b30-4cd59cb2aba1" }, { "name": "SlashID-Required-Consistency", "value": "" }, { "name": "SlashID-Required-Consistency-Timeout", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new set of credentials for your organization to use with third party services. Includes a provider name and a content whose body is a key value pair of the data needed to authenticate with the third party service - currently only API Key, API ID/API Key, Client Credentials, Access Token and username/password combinations are supported.\n" }, { "info": { "name": "Remove an external credential by id", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.slashid.com/organizations/config/external-credentials", "headers": [ { "name": "SlashID-OrgID", "value": "af5fbd30-7ce7-4548-8b30-4cd59cb2aba1" }, { "name": "SlashID-Required-Consistency", "value": "" }, { "name": "SlashID-Required-Consistency-Timeout", "value": "" } ], "params": [ { "name": "credentialId", "value": "", "type": "query", "description": "The id of the credential to delete" }, { "name": "deleteAll", "value": "", "type": "query", "description": "Whether to delete all credentials" } ] }, "docs": "Remove the specified external credential by id or delete all external credentials. If a credential id is specified, it takes precedence over the deleteAll parameter, so a request with a credentialId specified and deleteAll=true will delete only the specified credential from the list of external credentials. If the specified credential id does not exist in the list of allowed origin credentials, no action will be taken, and a 200 status code will be returned.\n" }, { "info": { "name": "Get the specified credential", "type": "http" }, "http": { "method": "GET", "url": "https://api.slashid.com/organizations/config/external-credentials/:cred_id", "headers": [ { "name": "SlashID-OrgID", "value": "af5fbd30-7ce7-4548-8b30-4cd59cb2aba1" } ], "params": [ { "name": "cred_id", "value": "", "type": "path", "description": "ID of the credential to retrieve, modify or delete" } ] }, "docs": "Returns the credential specified by the ID. The returned object contains the name of the provider, the credential type and an object which contains the credential material necessary to access a third-party provider (API Key, API ID/API Key, Client Credentials, Access Token and username/password)\n" }, { "info": { "name": "Modify the selected credential", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.slashid.com/organizations/config/external-credentials/:cred_id", "headers": [ { "name": "SlashID-OrgID", "value": "af5fbd30-7ce7-4548-8b30-4cd59cb2aba1" }, { "name": "SlashID-Required-Consistency", "value": "" }, { "name": "SlashID-Required-Consistency-Timeout", "value": "" } ], "params": [ { "name": "cred_id", "value": "", "type": "path", "description": "ID of the credential to retrieve, modify or delete" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set the content of the selected credential to be the request body. If the content or name for this\ncredential had previously been created for your organization, it will be overwritten and cannot\nbe retrieved. Otherwise, the new content will be set." } ] } ], "bundled": true }