Create Token

Create Token

Creates access token and refresh token for user access

Request
URI
POST
https://{api_host}/v1/tokens
COPY
Request Body
TokenCreationSpec of type(s) application/json
Required 
{
    "username": "string",
    "password": "string",
    "apiKey": "string",
    "idToken": "string"
}
string
username
Optional

Username

string
password
Optional

User Password

string
apiKey
Optional

API Key

string
idToken
Optional

Id Token

Responses
201

Created

Returns TokenPair of type(s) application/json 
"TokenPair Object"
string
accessToken
Optional

Bearer token that can be used to make public API calls

object
refreshToken
Optional

This contains refresh token id for the user API access.


400

Bad Request

Returns Error of type(s) application/json 
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.


500

Internal Server Error

Returns Error of type(s) application/json 
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.


Code Samples
COPY 
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/v1/tokens
On This Page
Tokens Operations
POST
Create Token
PATCH
Refresh Access Token
DELETE
Invalidate Refresh Token