Sign in
Auth API

Create Access Token

Changed on

API to create a new access token.

If roles are specified, all specified roles must be assigned to the user. If any role is not assigned to the user, the request fails and no token is created. If no roles are specified, the access token inherits all of the user's current roles from the user_roles table.

post/api/auth/access_token/{token_name}

Request

  • The document declares no server URL.
  • Auth: none declared

Path parameters

token_namestring required

Query parameters

expires_atstring required
descriptionstring
rolesstring[] nullable

Headers

x-osmo-userstring nullable

Response

Successful Response

string required

Changes

  • b9d312a13f5dRevision changes
    • ○

      added the optional property // to the response with the status

    • ○

      added the optional property // to the response with the status

  • a8157dc3279dRevision changes
    • ○

      header request parameter x-osmo-user list-of-types was widened by adding types null

    • ○

      query request parameter roles list-of-types was widened by adding types null

    • ○

      for the header request parameter x-osmo-user, the type was generalized from string to no type

    • ○

      for the query request parameter roles, the type was generalized from array to no type