Verifies that user credentials are valid.

Method

POST /identity/verify

Parameters

Request Body

A JSON object with the following properties:

Name Type Description
username String The username of a user.
password String A password of a user.

Result

A JSON object containing username and current authentication status. Its properties are as follows:

Name Value Description
authenticatedUser String An id of authenticated user.
isAuthenticated boolean A flag indicating if user is authenticated.

Response Codes

Code Media type Description
200 application/json Request successful.
400 application/json If body does not contain username or password.

Example

Request

POST /identity/verify

Request Body:

{
  "username": "testUser",
  "password": "testPassword"
}

Response

Status 200.

Response Body:

{
  "authenticatedUser": "testUser",
  "isAuthenticated": true
}

On this Page: