Create a new API token for a given organization.
If successful, this endpoint will return a 200 OK status.
One of the following scopes are required to use this endpoint.
The following arguments are supported for this endpoint.
Name | Type | Default Value |
---|---|---|
organization Required The organization to create the API token for |
Organization Lookup | None |
properties Required The properties for the new API token |
APITokenArguments | None |
annotations Annotations for this API token |
KeyValue Array | None |
The following errors may occur during this request.
Details | HTTP status |
---|---|
An organization was found from the arguments provided but it wasn't activated yet |
403 Forbidden |
No organization was found matching any of the criteria provided in the arguments |
404 Not Found |
An organization was found from the arguments provided but it was suspended |
403 Forbidden |
The authenticated identity is not permitted to perform this action |
403 Forbidden |
A validation error occurred with the object that was being created/updated/deleted |
422 Unprocessable Entity |
When the request is successful, you can expect an object matching the specification below to be returned.
{ api_token: APIToken { id: String name: String organization_id: String? authorized_ip_addresses: [ String ] expires_at: Unix Timestamp? rate_limit: Integer scopes: [ String ] secret: String? } annotations: [ KeyValue { key: String value: String? } ] }