createOrgApiToken
Create an organization API token with a display name, scoped privileges, and optional source IP restrictions. Note that the full token key is only available at creation time.
Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.
Format:
Authorization: Token {apitoken}
Notes:
- An API token generated for a specific admin has the same privileges as that admin
- An API token is automatically removed if it is not used for more than 90 days
- SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.
In: header
Path Parameters
uuidRequest Body
application/json
Organization API token with scoped privileges
Note:
privileges is required to create the object, but may not be returned in the POST API response. Retrieve the token afterward to inspect it.
Display name of the organization API token
Access scopes and roles granted to the organization API token
1 <= items <= 10Allowed source IP addresses or CIDRs from which the token may be used
value <= 10Response Body
curl -X POST "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/apitokens" \ -H "Content-Type: application/json" \ -d '{ "name": "org_token_xyz" }'{ "created_by": "user@mycorp.com", "created_time": 1626875902, "id": "497f6eca-6276-4993-bfeb-53efbbba6f08", "key": "1qkb...QQCL", "last_used": 1690115110, "name": "org_token_xyz", "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b", "privileges": [ { "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b", "role": "admin", "scope": "org" } ]}listOrgApiTokens GET
List organization API tokens, including display names, scoped privileges, allowed source IPs, creator, and last-use metadata.
getOrgApiToken GET
Return metadata for one organization API token. The full token key is only available at creation time and may only be partially shown afterward.