Test authentication

Use this endpoint to check if your request are authenticated properly.

GET/example

Path parameters

apiBasePathstringrequired

Its value depends on the apiBasePath set by the user

Responses

200The session passed verification and went through the application code

401The session doesn't exists or if it needs to be refreshed

messagestring

unauthorised or try refresh token

403The session exists, but didn't pass a claim validator

messagestring

claimValidationErrorsobject[]

Show properties

Array of object

idstring

reasonobject

Try it

Server

Custom base URLOverrides the selected server when set.

Parameters

apiBasePathpath*Its value depends on the apiBasePath set by the user

Request

curl -X GET "/example"

const response = await fetch("/example", {
  method: "GET"
});

import requests

response = requests.get(
    "/example",
)

Response

The session passed verification and went through the application code

{
  "message": "try refresh token"
}

{
  "message": "invalid claim",
  "claimValidationErrors": [
    {
      "id": "st-ev",
      "reason": {
        "message": "value does not exist",
        "expectedValue": "val",
        "actualValue": "claimVal"
      }
    }
  ]
}