Skip to main content
POST
/
api
/
v1
/
AccessToken
Creates an Access Token for an API User
curl --request POST \
  --url https://api.example.com/api/v1/AccessToken \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "userName": "<string>",
  "password": "<string>"
}
'
{
  "isSuccess": true,
  "message": "<string>",
  "payload": "<string>"
}

Authorizations

Authorization
string
header
required

Enter the Bearer AccessToken; Example: 'Bearer 12345abcdef'

Body

application/json

The username and password

userName
string | null

The username of the person. Can be a word or email

password
string | null

The password of the person

Response

OK

Generic container for all service responses

isSuccess
boolean

Was the request successful. If not, the message will have more information.

message
string | null

Any error message

payload
string | null

The payload object of the response