The sessions API endpoints support operations to create, read, and delete session resources.

Session request query parameters

query parameter Description
authenticated A booliean that specifies whether this is an authenticated session.
authorities[0].authority An array string that lists the account login authorities.
credentials An object that specifies the login credentials.
details An object that specifies the session details.
principal An object that specifies the session principal.

Session token claims

Claim Description
sub A string that specifies the subject of the session JWT.
aud A string that audience of the session JWT.
iss A string that specifies the issuer of the session JWT.
iat The time and date the session JWT was issued.
exp The time and date the session JWT expires.
jti A unique identifier for the JWT.
aty A list of authorities associated with the session JWT.
oiat The time and date the session was originally issued.

Response codes

Code Message
200 Successful operation.
201 Successfully created.
204 Successfully removed. No content.
400 The request could not be completed.
401 You do not have access to this resource.
403 You do not have permissions or are not licensed to make this request, or your license is exceeded.
404 The requested resource was not found.
500 An unexpected error occurred.