Create an access token for a user

POST 
/v1/users/:username/tokens

Create an access token for a user

Request

Path Parameters

username anyrequired

target user's name

application/json

Body

required

ttlnumber

token expiration in seconds

Possible values: >= 300 and <= 31536000

namestringrequired

Possible values: non-empty and <= 255 characters

token_typestring
Possible values: [read_write, read_scaling]
Default value: read_write

Responses

200

Successful response

application/json

Schema

Schema

tokenstringrequired

access token

iduuidrequired
namestring
expire_atstring

Time token expires at

created_tsstringrequired

Time token was originally created

read_onlybooleanrequired
token_typestringrequired

Possible values: [read_write, read_scaling]

Example (from schema)

{
  "token": "string",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "expire_at": "string",
  "created_ts": "string",
  "read_only": true,
  "token_type": "read_write"
}

400

Bad Request

application/json

Schema

Schema

messagestringrequired
The error message
Example: Bad Request
codestringrequired
The error code
Example: BAD_REQUEST

issues

object[]

An array of issues that were responsible for the error

Array [

messagestringrequired

]

Example (from schema)

{
  "code": "BAD_REQUEST",
  "message": "Bad Request",
  "issues": []
}

401

Invalid Credentials

application/json

Schema

Schema

messagestringrequired
The error message
Example: Invalid Credentials
codestringrequired
The error code
Example: UNAUTHORIZED

issues

object[]

An array of issues that were responsible for the error

Array [

messagestringrequired

]

Example (from schema)

{
  "code": "UNAUTHORIZED",
  "message": "Invalid Credentials",
  "issues": []
}

403

Unauthorized

application/json

Schema

Schema

messagestringrequired
The error message
Example: Unauthorized
codestringrequired
The error code
Example: FORBIDDEN

issues

object[]

An array of issues that were responsible for the error

Array [

messagestringrequired

]

Example (from schema)

{
  "code": "FORBIDDEN",
  "message": "Unauthorized",
  "issues": []
}

404

Not Found

application/json

Schema

Schema

messagestringrequired
The error message
Example: Not Found
codestringrequired
The error code
Example: NOT_FOUND

issues

object[]

An array of issues that were responsible for the error

Array [

messagestringrequired

]

Example (from schema)

{
  "code": "NOT_FOUND",
  "message": "Not Found",
  "issues": []
}

500

Internal Error

application/json

Schema

Schema

messagestringrequired
The error message
Example: Internal Error
codestringrequired
The error code
Example: INTERNAL_SERVER_ERROR

issues

object[]

An array of issues that were responsible for the error

Array [

messagestringrequired

]

Example (from schema)

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal Error",
  "issues": []
}