auth

Login with username and password to obtain a Knox token

Changed on

Authenticate user credentials and return an authentication token for API access

post/auth/login/

Request

  • The document declares no server URL.
  • Auth: one of:
    • API key in header Authorization
    • none

Request body

usernamestring required
passwordstring required

Response

tokenstring required

Authentication token

expirystring date-time required

Token expiry time

Changes

  • aa7b100ef965Revision changes
    • breaking

      removed the required property /////// from the response with the status

  • edd2c4f2de3bRevision changes
    • breaking

      the ///// response property's maxLength was unset from 150 for the response status

    • breaking

      removed the required property ///// from the response with the status

    • warning

      removed the optional property ///// from the response with the status

    • warning

      removed the optional property ///// from the 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

    • info

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

    • info

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

    • info

      the ///// response's property pattern ^[\w.@+-]+$ was removed for 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

      the response required property ///// became read-only for the status