Admin

Auth Token Create

Changed on

Create an auth token

post/api/v1.admin.auth-token.create

Request

  • The document declares no server URL.
  • Auth
    HTTP bearer

Request body

namestring required
rolestring required
expiry_msinteger nullable

Milliseconds from now until the token expires.

enabledboolean

Whether the token is enabled. Defaults to true.

Example request

{
  "name": "some token name",
  "role": "some token role"
}

Response

idstring required
tokenstring required
createdinteger required
updatedinteger required

Example response

{
  "id": "key_06etngr201xwv7qj08mt4cs03w"
}

Changes

  • a542ced3f593Revision changes
    • warning

      added the new invalid-input enum value to the response property for the response status

    • warning

      added the new invalid-input enum value to the response property for the response status

    • warning

      added the new invalid-input enum value to the response property for the response status

    • warning

      added the new invalid-input enum value to the response property for the response status

    • warning

      added the new operation-error enum value to the response property for the response status

    • warning

      added the new operation-error enum value to the response property for the response status

    • warning

      added the new operation-error enum value to the response property for the response status

    • warning

      added the new operation-error enum value to the response property for the response status

    • warning

      added the new server-error enum value to the response property for the response status

    • warning

      added the new server-error enum value to the response property for the response status

    • warning

      added the new server-error enum value to the response property for the response status

    • warning

      added the new server-error enum value to the response property for the response status

    • info

      removed the invalid_input enum value from the response property for the response status

    • info

      removed the invalid_input enum value from the response property for the response status

    • info

      removed the invalid_input enum value from the response property for the response status

    • info

      removed the invalid_input enum value from the response property for the response status

    • info

      removed the operation_error enum value from the response property for the response status

    • info

      removed the operation_error enum value from the response property for the response status

    • info

      removed the operation_error enum value from the response property for the response status

    • info

      removed the operation_error enum value from the response property for the response status

    • info

      removed the server_error enum value from the response property for the response status

    • info

      removed the server_error enum value from the response property for the response status

    • info

      removed the server_error enum value from the response property for the response status

    • info

      removed the server_error enum value from the response property for the response status

  • b1d873e9a6e4Revision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status