Issue an OAuth token

post/v1/oauth/token/

Request

Query parameters

expires_ininteger

The number of seconds the access token will be valid for. Defaults to, and is clamped by, the system default.

Headers

Authorizationstring

HTTP Basic credentials for a confidential client (client_secret_basic), as an alternative to sending client_id / client_secret in the form body.

Request body application/x-www-form-urlencoded

client_idstring

The OAuth2 client ID (application ID). Required unless the client authenticates with HTTP Basic.

client_secretstring

The OAuth2 client secret (required for the client_credentials grant unless sent as HTTP Basic credentials)

codestring

The authorization code (required for authorization_code grant)

code_verifierstring

The PKCE code verifier (required for authorization_code grant)

grant_type'authorization_code' | 'client_credentials' | 'refresh_token' required

The OAuth2 grant type

redirect_uristring

The redirect URI used in the authorization request (required for authorization_code grant)

refresh_tokenstring

The refresh token (required for refresh_token grant)

scopestring

The requested scope. Used by the client_credentials grant, and by the refresh_token grant to request a subset of the scope already granted (a broader scope is rejected).

Response

Returns a new generated token for particular user

app_idstring uuid
date_createdstring date-time
date_modifiedstring date-time
expiresstring date-time
idstring uuid
is_adminboolean
is_mfa_authenticatedboolean
is_saml_authenticatedboolean
is_super_adminboolean
is_super_admin_lightboolean
system_domain_idstring uuid
system_domain_is_plgboolean
system_domain_status'ACTIVE' | 'WARNING' | 'FROZEN' | 'DEACTIVATED'
system_domain_typestring
system_domain_warning_messagestring
system_domainsstring[]
tokenstring required
user_idstring uuid

Changes

No recorded changes to this operation across all 1 revision of this API.