NAnavigatr
Authentication

Token

Changed on

Get a token by logging in with your Keycloak credentials. username and password are required. See "Request body" below. The username field can also be an e-mail address.

Returns HTTP 200 containing bearer token:

{
    "access_token": (str)
}

Raises HTTP 401 if username/password is incorrect. Raises HTTP 423 if the IP has exceeded the maximum number of login attempts.

post/v1/token

Request

Request body application/x-www-form-urlencoded

grant_typestring nullable
usernamestring required
passwordstring password required
scopestring
client_idstring nullable
client_secretstring password nullable

Response

Successful Response

access_tokenstring required
refresh_tokenstring nullable
id_tokenstring nullable

Changes

  • 4039d06e340bRevision changes
    • info

      api operation id Token_v1_token_post removed and replaced with authentication_token

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

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

    • info

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

  • 6eb631bcc695Revision changes
    • breaking

      the request property format changed from no format to password

    • breaking

      response property id_token list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property refresh_token list-of-types was widened by adding types null to media type application/json of response 200

    • info

      request property list-of-types was widened by adding types null to media type application/x-www-form-urlencoded

    • info

      request property list-of-types was widened by adding types null to media type application/x-www-form-urlencoded

    • info

      request property list-of-types was widened by adding types null to media type application/x-www-form-urlencoded

    • info

      removed the pattern ^password$ from the request property