Get an authorization code

post

https://{hostname}/access/getAuthorizationCode

Returns an authorization code you can exchange for an access token and a refresh token.

Form Data

for_client_id

string

Unique identifier of the API client

integer

Unique identifier of the user logging in. Required unless you use the uuid or key_attribute parameter.

key_attribute

string

Name of a unique attribute in the schema. Required unless you use the id or uuid member. If you use key_attribute, your operation needs to include the key_value member as well.

key_value

string

Value for the attribute specified by the key_attribute parameter. String values are enclosed in quotes.

lifetime

string

Defaults to 30

Number of seconds for which the authorization code is valid.

redirect_uri

string

Either the redirect URL used to obtain an authorization code or the redirectUri setting configured in a JavaScript SDK-based implementation. Required only when the grant_type is set to authorization_code

transaction_state

string

JSON string associated with the authorization code and returned when that code is exchanged for an access token and a refresh token.

type_name

string

Name of the user profile database where the user’s user profile is stored

uuid

string

Unique identifier for the user logging in. Required unless you're using the id or key_attribute parameters to identify the user record.

Response

Language

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful response