Authentication

Verifies user or application authentication

Changed on

Takes a user's login ID and password and checks them against the user rolls.

If the user is found and authenticated, a session is created.

Otherwise the system will return an 'authentication failed' message.

post/api/v1/authentication

Request

Request body

userIdstring required
passwordstring required
rememberMeboolean
backEndLoginboolean
languagestring
countrystring

Response

User authentication successful

entityobject
i18nMessagesMapobject
permissionsstring[]

Changes

    • breaking

      removed the required property / from the response with the 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

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      api operation id postAuthentication removed and replaced with postAuthenticationV1