{ "info": { "_postman_id": "3011a4d7-1dfe-4029-83bf-4636ba76c971", "name": "API Access", "description": "API Access REST API Collection", "schema": "https://schema.getpostman.com/json/collection/v2.0.0/collection.json" }, "item": [ { "name": "API Token", "description": "API Token APIs", "item": [ { "name": "Get all API tokens in an org", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}orgs/:orgId/api-tokens", "query": [ { "key": "q", "value": "{{q}}", "disabled": true, "description": "Free text search filter to be applied to API token results. Query will be applied using a fuzzy, case-insensitive search. Will target token `label`, `user.name`, and `user.email`." }, { "key": "status", "value": "{{status}}", "disabled": true, "description": "Filter the API tokens by status to retrieve tokens of a specific type." }, { "key": "createdAtSearchType", "value": "{{createdAtSearchType}}", "disabled": true, "description": "Filter the API tokens by creation date. This parameter is **required** if searching on creation date. Depending on search type provided, additional parameters shall be supplied." }, { "key": "createdAtUom", "value": "{{createdAtUom}}", "disabled": true, "description": "Filter the API tokens by creation date. Unit of measure represents the scale of time for window search. This parameter is **required** if searching on creation date using `gt` or `lt` search." }, { "key": "createdAtValue", "value": "{{createdAtValue}}", "disabled": true, "description": "Filter the API tokens by creation date. This represents the value of time scale for window search. This parameter is **required** if searching on creation date using `gt` or `lt` search." }, { "key": "createdAtFrom", "value": "{{createdAtFrom}}", "disabled": true, "description": "Filter the API tokens by creation date. This represents the starting timestamp for a window search. Either this parameter or `createdAtTo` is **required** if searching on creation date using `range` search." }, { "key": "createdAtTo", "value": "{{createdAtTo}}", "disabled": true, "description": "Filter the API tokens by creation date. This represents the ending timestamp for a window search. Either this parameter or `createdAtFrom` is **required** if searching on creation date using `range` search." }, { "key": "createdAtRangeFrom", "value": "{{createdAtRangeFrom}}", "disabled": true, "description": "Filter the API tokens by creation date range. This represents the starting relative time window for a range time search. Either this parameter is or `createdAtRangeTo` is **required** if searching on creation date using `range_time` search.**Note:** Range time windows use the format `1w 2d 3h 4m` where `w -> weeks, d -> days, h -> hours, m -> minutes`. Look-back is possible with the use of `-`, ex: `-3w` to indicate \"3 weeks ago.\" Values are optional and must be presented in descending order." }, { "key": "createdAtRangeTo", "value": "{{createdAtRangeTo}}", "disabled": true, "description": "Filter the API tokens by creation date range. This represents the ending relative time window for a range time search. Either this parameter is or `createdAtRangeFrom` is **required** if searching on creation date using `range_time` search.**Note:** Range time windows use the format `1w 2d 3h 4m` where `w -> weeks, d -> days, h -> hours, m -> minutes`. Look-back is possible with the use of `-`, ex: `-3w` to indicate \"3 weeks ago.\" Values are optional and must be presented in descending order." }, { "key": "lastActiveAtSearchType", "value": "{{lastActiveAtSearchType}}", "disabled": true, "description": "Filter the API tokens by last active date. This parameter is **required** if searching on last active date. Depending on search type provided, additional parameters shall be supplied." }, { "key": "lastActiveAtUom", "value": "{{lastActiveAtUom}}", "disabled": true, "description": "Filter the API tokens by last active date. Unit of measure represents the scale of time for window search. This parameter is **required** if searching on last active date using `gt` or `lt` search." }, { "key": "lastActiveAtValue", "value": "{{lastActiveAtValue}}", "disabled": true, "description": "Filter the API tokens by last active date. This represents the value of time scale for window search. This parameter is **required** if searching on last active date using `gt` or `lt` search." }, { "key": "lastActiveAtFrom", "value": "{{lastActiveAtFrom}}", "disabled": true, "description": "Filter the API tokens by last active date. This represents the starting timestamp for a window search. Either this parameter or `lastActiveAtTo` is **required** if searching on last active date using `range` search." }, { "key": "lastActiveAtTo", "value": "{{lastActiveAtTo}}", "disabled": true, "description": "Filter the API tokens by last active date. This represents the ending timestamp for a window search. Either this parameter or `lastActiveAtFrom` is **required** if searching on last active date using `range` search." }, { "key": "lastActiveAtRangeFrom", "value": "{{lastActiveAtRangeFrom}}", "disabled": true, "description": "Filter the API tokens by last active date range. This represents the starting relative time window for a range time search. Either this parameter is or `lastActiveAtRangeTo` is **required** if searching on last active date using `range_time` search.**Note:** Range time windows use the format `1w 2d 3h 4m` where `w -> weeks, d -> days, h -> hours, m -> minutes`. Look-back is possible with the use of `-`, ex: `-3w` to indicate \"3 weeks ago.\" Values are optional and must be presented in descending order." }, { "key": "lastActiveAtRangeTo", "value": "{{lastActiveAtRangeTo}}", "disabled": true, "description": "Filter the API tokens by last active date range. This represents the ending relative time window for a range time search. Either this parameter is or `lastActiveAtRangeFrom` is **required** if searching on last active date using `range_time` search.**Note:** Range time windows use the format `1w 2d 3h 4m` where `w -> weeks, d -> days, h -> hours, m -> minutes`. Look-back is possible with the use of `-`, ex: `-3w` to indicate \"3 weeks ago.\" Values are optional and must be presented in descending order." }, { "key": "sort", "value": "{{sort}}", "disabled": true, "description": "Sort the API tokens based on the following criteria: ascending is represented with `+` as the first character (optional); descending is represented with `-` as the first character. Multiple values may be supplied as a comma-separated list." }, { "key": "pageSize", "value": "{{pageSize}}", "disabled": true, "description": "Select the number of records to include in the results." }, { "key": "cursor", "value": "{{cursor}}", "disabled": true, "description": "Navigate to a specific page of paginated results. In a given response, it may include a `self`, `next`, and `prev` cursor to fetch the respective set of paginated results. The cursor only encodes the sort value and record ID — it does not encode filters, sort order, or page size.**Note:** You must continue to pass all other parameters (filters, sort, pageSize) on every request alongside the cursor." } ], "variable": [ { "key": "orgId", "value": "{{orgId}}", "description": "Your organization is identified by a Unique ID. You get your organization ID and organization API key simultaneously.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Gets all [user API tokens](/cloud/admin/api-access/rest/intro/#API%20Tokens) in an organization.\n\n#### Scopes\n**[Authorization scopes](/cloud/admin/scopes/) required:** `read:tokens:admin`\n" }, "response": [] }, { "name": "Bulk revoke API tokens in an organization", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}orgs/:orgId/api-tokens", "query": [], "variable": [ { "key": "orgId", "value": "{{orgId}}", "description": "Id of organization revoking the token", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Revokes all managed user API tokens in an organization by orgID.\n#### Scopes\n**[Authorization scopes](/cloud/admin/scopes/) required:** `delete:tokens:admin`\n" }, "response": [] }, { "name": "Get API token count in an org", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}orgs/:orgId/api-tokens/count", "query": [ { "key": "q", "value": "{{q}}", "disabled": true, "description": "Free text search filter to be applied to API token results. Query will be applied using a fuzzy, case-insensitive search. Will target token `label`, `user.name`, and `user.email`." }, { "key": "status", "value": "{{status}}", "disabled": true, "description": "Filter the API tokens by status to retrieve tokens of a specific type." }, { "key": "createdAtSearchType", "value": "{{createdAtSearchType}}", "disabled": true, "description": "Filter the API tokens by creation date. This parameter is **required** if searching on creation date. Depending on search type provided, additional parameters shall be supplied." }, { "key": "createdAtUom", "value": "{{createdAtUom}}", "disabled": true, "description": "Filter the API tokens by creation date. Unit of measure represents the scale of time for window search. This parameter is **required** if searching on creation date using `gt` or `lt` search." }, { "key": "createdAtValue", "value": "{{createdAtValue}}", "disabled": true, "description": "Filter the API tokens by creation date. This represents the value of time scale for window search. This parameter is **required** if searching on creation date using `gt` or `lt` search." }, { "key": "createdAtFrom", "value": "{{createdAtFrom}}", "disabled": true, "description": "Filter the API tokens by creation date. This represents the starting timestamp for a window search. Either this parameter or `createdAtTo` is **required** if searching on creation date using `range` search." }, { "key": "createdAtTo", "value": "{{createdAtTo}}", "disabled": true, "description": "Filter the API tokens by creation date. This represents the ending timestamp for a window search. Either this parameter or `createdAtFrom` is **required** if searching on creation date using `range` search." }, { "key": "createdAtRangeFrom", "value": "{{createdAtRangeFrom}}", "disabled": true, "description": "Filter the API tokens by creation date range. This represents the starting relative time window for a range time search. Either this parameter is or `createdAtRangeTo` is **required** if searching on creation date using `range_time` search.**Note:** Range time windows use the format `1w 2d 3h 4m` where `w -> weeks, d -> days, h -> hours, m -> minutes`. Look-back is possible with the use of `-`, ex: `-3w` to indicate \"3 weeks ago.\" Values are optional and must be presented in descending order." }, { "key": "createdAtRangeTo", "value": "{{createdAtRangeTo}}", "disabled": true, "description": "Filter the API tokens by creation date range. This represents the ending relative time window for a range time search. Either this parameter is or `createdAtRangeFrom` is **required** if searching on creation date using `range_time` search.**Note:** Range time windows use the format `1w 2d 3h 4m` where `w -> weeks, d -> days, h -> hours, m -> minutes`. Look-back is possible with the use of `-`, ex: `-3w` to indicate \"3 weeks ago.\" Values are optional and must be presented in descending order." }, { "key": "lastActiveAtSearchType", "value": "{{lastActiveAtSearchType}}", "disabled": true, "description": "Filter the API tokens by last active date. This parameter is **required** if searching on last active date. Depending on search type provided, additional parameters shall be supplied." }, { "key": "lastActiveAtUom", "value": "{{lastActiveAtUom}}", "disabled": true, "description": "Filter the API tokens by last active date. Unit of measure represents the scale of time for window search. This parameter is **required** if searching on last active date using `gt` or `lt` search." }, { "key": "lastActiveAtValue", "value": "{{lastActiveAtValue}}", "disabled": true, "description": "Filter the API tokens by last active date. This represents the value of time scale for window search. This parameter is **required** if searching on last active date using `gt` or `lt` search." }, { "key": "lastActiveAtFrom", "value": "{{lastActiveAtFrom}}", "disabled": true, "description": "Filter the API tokens by last active date. This represents the starting timestamp for a window search. Either this parameter or `lastActiveAtTo` is **required** if searching on last active date using `range` search." }, { "key": "lastActiveAtTo", "value": "{{lastActiveAtTo}}", "disabled": true, "description": "Filter the API tokens by last active date. This represents the ending timestamp for a window search. Either this parameter or `lastActiveAtFrom` is **required** if searching on last active date using `range` search." }, { "key": "lastActiveAtRangeFrom", "value": "{{lastActiveAtRangeFrom}}", "disabled": true, "description": "Filter the API tokens by last active date range. This represents the starting relative time window for a range time search. Either this parameter is or `lastActiveAtRangeTo` is **required** if searching on last active date using `range_time` search.**Note:** Range time windows use the format `1w 2d 3h 4m` where `w -> weeks, d -> days, h -> hours, m -> minutes`. Look-back is possible with the use of `-`, ex: `-3w` to indicate \"3 weeks ago.\" Values are optional and must be presented in descending order." }, { "key": "lastActiveAtRangeTo", "value": "{{lastActiveAtRangeTo}}", "disabled": true, "description": "Filter the API tokens by last active date range. This represents the ending relative time window for a range time search. Either this parameter is or `lastActiveAtRangeFrom` is **required** if searching on last active date using `range_time` search.**Note:** Range time windows use the format `1w 2d 3h 4m` where `w -> weeks, d -> days, h -> hours, m -> minutes`. Look-back is possible with the use of `-`, ex: `-3w` to indicate \"3 weeks ago.\" Values are optional and must be presented in descending order." } ], "variable": [ { "key": "orgId", "value": "{{orgId}}", "description": "Your organization is identified by a Unique ID. You get your organization ID and organization API key simultaneously.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Gets count of [user API tokens](/cloud/admin/api-access/rest/intro/#API%20Tokens) in an organization.\n\n#### Scopes\n**[Authorization scopes](/cloud/admin/scopes/) required:** `read:tokens:admin`\n" }, "response": [] }, { "name": "Get service account API token count in an org", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}orgs/:orgId/service-accounts/count", "query": [], "variable": [ { "key": "orgId", "value": "{{orgId}}", "description": "Your organization is identified by a Unique ID. You get your organization ID and organization API key simultaneously.", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Gets count of API tokens for specified service accounts within an organization.\n\n#### Scopes\n**[Authorization scopes](/cloud/admin/scopes/) required:** `read:service-accounts-tokens:admin`\n", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Revoke all API tokens for a service account", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}orgs/:orgId/service-accounts/:serviceAccountId/api-tokens", "query": [], "variable": [ { "key": "orgId", "value": "{{orgId}}", "description": "Your organization is identified by a Unique ID. You get your organization ID and organization API key simultaneously.", "disabled": false }, { "key": "serviceAccountId", "value": "{{serviceAccountId}}", "description": "ID for the service account whose API tokens you want to revoke.", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Revokes all API tokens for a specific service account within an organization.\n\n#### Scopes\n**[Authorization scopes](/cloud/admin/scopes/) required:** `delete:service-accounts-tokens:admin`\n" }, "response": [] } ] }, { "name": "API Key", "description": "API Key APIs", "item": [ { "name": "Get API key count in an org", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}orgs/:orgId/api-keys/count", "query": [ { "key": "q", "value": "{{q}}", "disabled": true, "description": "Free text search filter to be applied to API token results. Query will be applied using a fuzzy, case-insensitive search. Will target token `label`, `user.name`, and `user.email`." }, { "key": "keyType", "value": "{{keyType}}", "disabled": true, "description": "Key type filter for API keys to return keys of a certain type." }, { "key": "expiresAtSearchType", "value": "{{expiresAtSearchType}}", "disabled": true, "description": "Filter the API keys by expiry date. Depending on search type provided, additional parameters shall be supplied." }, { "key": "expiresAtUom", "value": "{{expiresAtUom}}", "disabled": true, "description": "Filter the API keys by expiry date. Unit of measure represents the scale of time for window search. This parameter is **required** if searching on expiry date using `gt` or `lt` search." }, { "key": "expiresAtValue", "value": "{{expiresAtValue}}", "disabled": true, "description": "Filter the API tokens by last active date. This represents the value of time scale for window search. This parameter is **required** if searching on expiry date using `gt` or `lt` search." }, { "key": "expiresAtFrom", "value": "{{expiresAtFrom}}", "disabled": true, "description": "Filter the API tokens by last active date. This represents the starting timestamp for a window search. Either this parameter or `expiresAtTo` is **required** if searching on expiry date using `range` search." }, { "key": "expiresAtTo", "value": "{{expiresAtTo}}", "disabled": true, "description": "Filter the API tokens by last active date. This represents the ending timestamp for a window search. Either this parameter or `expiresAtFrom` is **required** if searching on expiry date using `range` search." }, { "key": "expiresAtRangeFrom", "value": "{{expiresAtRangeFrom}}", "disabled": true, "description": "Filter the API keys by expiry date range. This represents the starting relative time window for a range time search. Either this parameter is or `expiresAtRangeTo` is **required** if searching on expiry date using `range_time` search.**Note:** Range time windows use the format `1w 2d 3h 4m` where `w -> weeks, d -> days, h -> hours, m -> minutes`. Look-back is possible with the use of `-`, ex: `-3w` to indicate \"3 weeks ago.\" Values are optional and must be presented in descending order." }, { "key": "expiresAtRangeTo", "value": "{{expiresAtRangeTo}}", "disabled": true, "description": "Filter the API keys by expiry date range. This represents the ending relative time window for a range time search. Either this parameter is or `expiresAtRangeFrom` is **required** if searching on expiry date using `range_time` search.**Note:** Range time windows use the format `1w 2d 3h 4m` where `w -> weeks, d -> days, h -> hours, m -> minutes`. Look-back is possible with the use of `-`, ex: `-3w` to indicate \"3 weeks ago.\" Values are optional and must be presented in descending order." }, { "key": "lastActiveAtSearchType", "value": "{{lastActiveAtSearchType}}", "disabled": true, "description": "Filter the API tokens by last active date. This parameter is **required** if searching on last active date. Depending on search type provided, additional parameters shall be supplied." }, { "key": "lastActiveAtUom", "value": "{{lastActiveAtUom}}", "disabled": true, "description": "Filter the API tokens by last active date. Unit of measure represents the scale of time for window search. This parameter is **required** if searching on last active date using `gt` or `lt` search." }, { "key": "lastActiveAtValue", "value": "{{lastActiveAtValue}}", "disabled": true, "description": "Filter the API tokens by last active date. This represents the value of time scale for window search. This parameter is **required** if searching on last active date using `gt` or `lt` search." }, { "key": "lastActiveAtFrom", "value": "{{lastActiveAtFrom}}", "disabled": true, "description": "Filter the API tokens by last active date. This represents the starting timestamp for a window search. Either this parameter or `lastActiveAtTo` is **required** if searching on last active date using `range` search." }, { "key": "lastActiveAtTo", "value": "{{lastActiveAtTo}}", "disabled": true, "description": "Filter the API tokens by last active date. This represents the ending timestamp for a window search. Either this parameter or `lastActiveAtFrom` is **required** if searching on last active date using `range` search." }, { "key": "lastActiveAtRangeFrom", "value": "{{lastActiveAtRangeFrom}}", "disabled": true, "description": "Filter the API tokens by last active date range. This represents the starting relative time window for a range time search. Either this parameter is or `lastActiveAtRangeTo` is **required** if searching on last active date using `range_time` search.**Note:** Range time windows use the format `1w 2d 3h 4m` where `w -> weeks, d -> days, h -> hours, m -> minutes`. Look-back is possible with the use of `-`, ex: `-3w` to indicate \"3 weeks ago.\" Values are optional and must be presented in descending order." }, { "key": "lastActiveAtRangeTo", "value": "{{lastActiveAtRangeTo}}", "disabled": true, "description": "Filter the API tokens by last active date range. This represents the ending relative time window for a range time search. Either this parameter is or `lastActiveAtRangeFrom` is **required** if searching on last active date using `range_time` search.**Note:** Range time windows use the format `1w 2d 3h 4m` where `w -> weeks, d -> days, h -> hours, m -> minutes`. Look-back is possible with the use of `-`, ex: `-3w` to indicate \"3 weeks ago.\" Values are optional and must be presented in descending order." } ], "variable": [ { "key": "orgId", "value": "{{orgId}}", "description": "Your organization is identified by a Unique ID. You get your organization ID and organization API key simultaneously.", "disabled": false } ] }, "method": "GET", "header": [ { "key": "Authorization", "value": "{{Authorization}}", "description": "Bearer token for authentication. The token is generated when you create properly scoped API key.\n\ne.g. `--header 'Authorization: Bearer '`\n", "disabled": false }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Gets count of user API keys in an organization.\n\n#### Scopes\n**[Authorization scopes](/cloud/admin/scopes/) required:** `read:keys:admin`\n" }, "response": [] }, { "name": "Get all API keys in an org", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}orgs/:orgId/api-keys", "query": [ { "key": "q", "value": "{{q}}", "disabled": true, "description": "Free text search filter to be applied to API token results. Query will be applied using a fuzzy, case-insensitive search. Will target token `label`, `user.name`, and `user.email`." }, { "key": "keyType", "value": "{{keyType}}", "disabled": true, "description": "Key type filter for API keys to return keys of a certain type." }, { "key": "expiresAtSearchType", "value": "{{expiresAtSearchType}}", "disabled": true, "description": "Filter the API keys by expiry date. Depending on search type provided, additional parameters shall be supplied." }, { "key": "expiresAtUom", "value": "{{expiresAtUom}}", "disabled": true, "description": "Filter the API keys by expiry date. Unit of measure represents the scale of time for window search. This parameter is **required** if searching on expiry date using `gt` or `lt` search." }, { "key": "expiresAtValue", "value": "{{expiresAtValue}}", "disabled": true, "description": "Filter the API tokens by last active date. This represents the value of time scale for window search. This parameter is **required** if searching on expiry date using `gt` or `lt` search." }, { "key": "expiresAtFrom", "value": "{{expiresAtFrom}}", "disabled": true, "description": "Filter the API tokens by last active date. This represents the starting timestamp for a window search. Either this parameter or `expiresAtTo` is **required** if searching on expiry date using `range` search." }, { "key": "expiresAtTo", "value": "{{expiresAtTo}}", "disabled": true, "description": "Filter the API tokens by last active date. This represents the ending timestamp for a window search. Either this parameter or `expiresAtFrom` is **required** if searching on expiry date using `range` search." }, { "key": "expiresAtRangeFrom", "value": "{{expiresAtRangeFrom}}", "disabled": true, "description": "Filter the API keys by expiry date range. This represents the starting relative time window for a range time search. Either this parameter is or `expiresAtRangeTo` is **required** if searching on expiry date using `range_time` search.**Note:** Range time windows use the format `1w 2d 3h 4m` where `w -> weeks, d -> days, h -> hours, m -> minutes`. Look-back is possible with the use of `-`, ex: `-3w` to indicate \"3 weeks ago.\" Values are optional and must be presented in descending order." }, { "key": "expiresAtRangeTo", "value": "{{expiresAtRangeTo}}", "disabled": true, "description": "Filter the API keys by expiry date range. This represents the ending relative time window for a range time search. Either this parameter is or `expiresAtRangeFrom` is **required** if searching on expiry date using `range_time` search.**Note:** Range time windows use the format `1w 2d 3h 4m` where `w -> weeks, d -> days, h -> hours, m -> minutes`. Look-back is possible with the use of `-`, ex: `-3w` to indicate \"3 weeks ago.\" Values are optional and must be presented in descending order." }, { "key": "lastActiveAtSearchType", "value": "{{lastActiveAtSearchType}}", "disabled": true, "description": "Filter the API tokens by last active date. This parameter is **required** if searching on last active date. Depending on search type provided, additional parameters shall be supplied." }, { "key": "lastActiveAtUom", "value": "{{lastActiveAtUom}}", "disabled": true, "description": "Filter the API tokens by last active date. Unit of measure represents the scale of time for window search. This parameter is **required** if searching on last active date using `gt` or `lt` search." }, { "key": "lastActiveAtValue", "value": "{{lastActiveAtValue}}", "disabled": true, "description": "Filter the API tokens by last active date. This represents the value of time scale for window search. This parameter is **required** if searching on last active date using `gt` or `lt` search." }, { "key": "lastActiveAtFrom", "value": "{{lastActiveAtFrom}}", "disabled": true, "description": "Filter the API tokens by last active date. This represents the starting timestamp for a window search. Either this parameter or `lastActiveAtTo` is **required** if searching on last active date using `range` search." }, { "key": "lastActiveAtTo", "value": "{{lastActiveAtTo}}", "disabled": true, "description": "Filter the API tokens by last active date. This represents the ending timestamp for a window search. Either this parameter or `lastActiveAtFrom` is **required** if searching on last active date using `range` search." }, { "key": "lastActiveAtRangeFrom", "value": "{{lastActiveAtRangeFrom}}", "disabled": true, "description": "Filter the API tokens by last active date range. This represents the starting relative time window for a range time search. Either this parameter is or `lastActiveAtRangeTo` is **required** if searching on last active date using `range_time` search.**Note:** Range time windows use the format `1w 2d 3h 4m` where `w -> weeks, d -> days, h -> hours, m -> minutes`. Look-back is possible with the use of `-`, ex: `-3w` to indicate \"3 weeks ago.\" Values are optional and must be presented in descending order." }, { "key": "lastActiveAtRangeTo", "value": "{{lastActiveAtRangeTo}}", "disabled": true, "description": "Filter the API tokens by last active date range. This represents the ending relative time window for a range time search. Either this parameter is or `lastActiveAtRangeFrom` is **required** if searching on last active date using `range_time` search.**Note:** Range time windows use the format `1w 2d 3h 4m` where `w -> weeks, d -> days, h -> hours, m -> minutes`. Look-back is possible with the use of `-`, ex: `-3w` to indicate \"3 weeks ago.\" Values are optional and must be presented in descending order." }, { "key": "sort", "value": "{{sort}}", "disabled": true, "description": "Sort the API keys based on the following criteria: ascending is represented with `+` as the first character (optional); descending is represented with `-` as the first character. Multiple values may be supplied as a comma-separated list." }, { "key": "pageSize", "value": "{{pageSize}}", "disabled": true, "description": "Select the number of records to include in the results." }, { "key": "cursor", "value": "{{cursor}}", "disabled": true, "description": "Navigate to a specific page of paginated results. In a given response, it may include a `self`, `next`, and `prev` cursor to fetch the respective set of paginated results. The cursor only encodes the sort value and record ID — it does not encode filters, sort order, or page size.**Note:** You must continue to pass all other parameters (filters, sort, pageSize) on every request alongside the cursor." } ], "variable": [ { "key": "orgId", "value": "{{orgId}}", "description": "Your organization is identified by a Unique ID. You get your organization ID and organization API key simultaneously.", "disabled": false } ] }, "method": "GET", "header": [ { "key": "Authorization", "value": "{{Authorization}}", "description": "Bearer token for authentication. The token is generated when you create properly scoped API key.\n\ne.g. `--header 'Authorization: Bearer '`\n", "disabled": false }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Gets all user API keys in an organization.\n\n#### Scopes\n**[Authorization scopes](/cloud/admin/scopes/) required:** `read:keys:admin`\n" }, "response": [] }, { "name": "Revoke an API key for an org", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}orgs/:orgId/api-keys/revoke/:apiKeyId", "query": [], "variable": [ { "key": "orgId", "value": "{{orgId}}", "description": "Your organization is identified by a Unique ID. You get your organization ID and organization API key simultaneously.", "disabled": false }, { "key": "apiKeyId", "value": "{{apiKeyId}}", "description": "ID for the API key you want to revoke.", "disabled": false } ] }, "method": "PATCH", "header": [], "description": "Revokes an existing API key\n\n#### Scopes\n**[Authorization scopes](/cloud/admin/scopes/) required:** `delete:keys:admin`\n" }, "response": [] } ] }, { "name": "OAuth Client", "description": "OAuth Client Management APIs", "item": [ { "name": "Get all OAuth clients in an org", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}orgs/:orgId/oauth-clients", "query": [ { "key": "pageSize", "value": "{{pageSize}}", "disabled": true, "description": "Select the number of OAuth client records to include in the results." }, { "key": "cursor", "value": "{{cursor}}", "disabled": true, "description": "Navigate to a specific page of paginated results. In a given response, it may include a `self`, `next`, and `prev` cursor to fetch the respective set of paginated results. The cursor only encodes the sort value and record ID — it does not encode filters, sort order, or page size.**Note:** You must continue to pass all other parameters (filters, sort, pageSize) on every request alongside the cursor." } ], "variable": [ { "key": "orgId", "value": "{{orgId}}", "description": "Your organization is identified by a Unique ID. You get your organization ID and organization API key simultaneously.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieves all OAuth clients for the specified organization.\n\n#### Scopes\n**[OAuth 2.0 scopes](/cloud/admin/scopes/) required:** `read:service-accounts-tokens:admin`\n" }, "response": [] }, { "name": "Create an OAuth client", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}orgs/:orgId/oauth-clients", "query": [], "variable": [ { "key": "orgId", "value": "{{orgId}}", "description": "Your organization is identified by a Unique ID. You get your organization ID and organization API key simultaneously.", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Creates a new OAuth client for the specified organization.\n\n> **Note:** This is a session-only endpoint and cannot be called with an API token or OAuth 2.0 scope. It requires an active admin session with org management permissions.\n\n#### Scopes\nThis endpoint is session-only and does not accept OAuth 2.0 scopes.\n", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Get OAuth client count in an org", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}orgs/:orgId/oauth-clients/count", "query": [], "variable": [ { "key": "orgId", "value": "{{orgId}}", "description": "Your organization is identified by a Unique ID. You get your organization ID and organization API key simultaneously.", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Gets the count of OAuth clients in the specified organization.\n\n#### Scopes\n**[OAuth 2.0 scopes](/cloud/admin/scopes/) required:** `read:service-accounts-tokens:admin`\n" }, "response": [] }, { "name": "Get an OAuth client", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}orgs/:orgId/oauth-clients/:clientId", "query": [], "variable": [ { "key": "orgId", "value": "{{orgId}}", "description": "Your organization is identified by a Unique ID. You get your organization ID and organization API key simultaneously.", "disabled": false }, { "key": "clientId", "value": "{{clientId}}", "description": "The unique identifier of the OAuth client.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieves a specific OAuth client by ID for the specified organization.\n\n#### Scopes\n**[OAuth 2.0 scopes](/cloud/admin/scopes/) required:** `read:service-accounts-tokens:admin`\n" }, "response": [] }, { "name": "Delete an OAuth client", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}orgs/:orgId/oauth-clients/:clientId", "query": [], "variable": [ { "key": "orgId", "value": "{{orgId}}", "description": "Your organization is identified by a Unique ID. You get your organization ID and organization API key simultaneously.", "disabled": false }, { "key": "clientId", "value": "{{clientId}}", "description": "The unique identifier of the OAuth client to delete.", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Deletes an existing OAuth client from the specified organization.\n\n#### Scopes\n**[OAuth 2.0 scopes](/cloud/admin/scopes/) required:** `delete:service-accounts-tokens:admin`\n" }, "response": [] } ] }, { "name": "Service Account", "description": "Service Account lifecycle and credential APIs", "item": [ { "name": "Get API tokens for all service accounts in an org", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}orgs/:orgId/service-accounts/api-tokens", "query": [ { "key": "tokenLabel", "value": "{{tokenLabel}}", "disabled": true, "description": "Optional filter to search for tokens by label." } ], "variable": [ { "key": "orgId", "value": "{{orgId}}", "description": "Your organization is identified by a Unique ID. You get your organization ID and organization API key simultaneously.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieves API tokens belonging to service accounts in the specified organization.\n\n#### Scopes\n**[OAuth 2.0 scopes](/cloud/admin/scopes/) required:** `read:service-accounts-tokens:admin`\n" }, "response": [] }, { "name": "Get API tokens for a service account", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}orgs/:orgId/service-accounts/:serviceAccountId/api-tokens", "query": [ { "key": "tokenLabel", "value": "{{tokenLabel}}", "disabled": true, "description": "Optional filter to search for tokens by label." } ], "variable": [ { "key": "orgId", "value": "{{orgId}}", "description": "Your organization is identified by a Unique ID. You get your organization ID and organization API key simultaneously.", "disabled": false }, { "key": "serviceAccountId", "value": "{{serviceAccountId}}", "description": "ID for the service account whose API tokens you want to retrieve.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieves API tokens for a specific service account within an organization.\n\n#### Scopes\n**[Authorization scopes](/cloud/admin/scopes/) required:** `read:service-accounts-tokens:admin`\n" }, "response": [] }, { "name": "List service accounts in an org", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}orgs/:orgId/service-accounts", "query": [], "variable": [ { "key": "orgId", "value": "{{orgId}}", "description": "Your organization is identified by a Unique ID. You get your organization ID and organization API key simultaneously.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieves all service accounts for the specified organization.\n\n#### Scopes\n**[OAuth 2.0 scopes](/cloud/admin/scopes/) required:** `read:service-accounts:admin`\n" }, "response": [] }, { "name": "Create a service account", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}orgs/:orgId/service-accounts", "query": [], "variable": [ { "key": "orgId", "value": "{{orgId}}", "description": "Your organization is identified by a Unique ID. You get your organization ID and organization API key simultaneously.", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Creates a new service account for the specified organization. The service account is created with the given display name and optional description, then invited with the specified permission rules and optional additional group memberships.\n\n#### Scopes\n**[OAuth 2.0 scopes](/cloud/admin/scopes/) required:** `write:service-accounts:admin`\n", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Update a service account", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}orgs/:orgId/service-accounts", "query": [], "variable": [ { "key": "orgId", "value": "{{orgId}}", "description": "Your organization is identified by a Unique ID. You get your organization ID and organization API key simultaneously.", "disabled": false } ] }, "method": "PATCH", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Updates a service account's display name and/or description within the specified organization.\n\n#### Scopes\n**[OAuth 2.0 scopes](/cloud/admin/scopes/) required:** `write:service-accounts:admin`\n", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Delete a service account", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}orgs/:orgId/service-accounts/:serviceAccountId", "query": [], "variable": [ { "key": "orgId", "value": "{{orgId}}", "description": "Your organization is identified by a Unique ID. You get your organization ID and organization API key simultaneously.", "disabled": false }, { "key": "serviceAccountId", "value": "{{serviceAccountId}}", "description": "The unique identifier of the service account to delete.", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Deletes a service account from the specified organization.\n\n#### Scopes\n**[OAuth 2.0 scopes](/cloud/admin/scopes/) required:** `write:service-accounts:admin`\n" }, "response": [] }, { "name": "Get OAuth clients for all service accounts in an org", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}orgs/:orgId/service-accounts/oauth-clients", "query": [ { "key": "clientName", "value": "{{clientName}}", "disabled": true, "description": "Optional filter to search for OAuth clients by name." } ], "variable": [ { "key": "orgId", "value": "{{orgId}}", "description": "Your organization is identified by a Unique ID. You get your organization ID and organization API key simultaneously.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieves OAuth clients belonging to service accounts in the specified organization.\n\n#### Scopes\n**[OAuth 2.0 scopes](/cloud/admin/scopes/) required:** `read:service-accounts-tokens:admin`\n" }, "response": [] }, { "name": "Get OAuth clients for a service account", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}orgs/:orgId/service-accounts/:serviceAccountId/oauth-clients", "query": [ { "key": "clientName", "value": "{{clientName}}", "disabled": true, "description": "Optional filter to search for OAuth clients by name." } ], "variable": [ { "key": "orgId", "value": "{{orgId}}", "description": "Your organization is identified by a Unique ID. You get your organization ID and organization API key simultaneously.", "disabled": false }, { "key": "serviceAccountId", "value": "{{serviceAccountId}}", "description": "ID for the service account whose OAuth clients you want to retrieve.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieves OAuth clients belonging to the specified service account.\n\n#### Scopes\n**[OAuth 2.0 scopes](/cloud/admin/scopes/) required:** `read:service-accounts-tokens:admin`\n" }, "response": [] } ] } ], "variable": [ { "key": "protocol", "name": "Protocol", "description": "The HTTP Protocol that should be used for this REST API.", "type": "string", "value": "https" }, { "key": "host", "name": "Host", "description": "The HTTP host that should be used for this REST API.", "type": "string", "value": "api.atlassian.com" }, { "key": "basePath", "name": "Base Path", "description": "The path, after the host, of the base of the REST API.", "type": "string", "value": "admin/api-access/v1/" } ] }