User Session data models

terminateUserSession — 401 response

Authorization is required to access this resource.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

terminateUserSession — 403 response

Request failed because of invalid data or denied permission.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

terminateUserSession — 404 response

The required userSession does not exist or is not accessible.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

terminateUserSession — 409 response

The userSession cannot be deleted because it is being used by another part of the system.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

terminateUserSession — 429 response

Request failed because of rate limit.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

terminateUserSession — 500 response

An unexpected error has occurred.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

terminateUserSession — 503 response

The service is temporarily unavailable.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

getUserSessionInfo — 200 response

Successful retrieval of current user session.

PropertyTypeRequiredConstraintsDescription
appIdstringYesread-only (server-generated)App used to initiated this session.
creationTimestringNoread-only (server-generated); format: date-timeTime when session started.
projectIdintegerYesread-only (server-generated)Project associated with this session.
userIdintegerYesread-only (server-generated)ID of the user associated with this session.

getUserSessionInfo — 401 response

Authorization is required to access this resource.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

getUserSessionInfo — 403 response

Request failed because of denied permission.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

getUserSessionInfo — 404 response

The requested userSession does not exist or is not accessible.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

getUserSessionInfo — 429 response

Request failed because of rate limit.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

getUserSessionInfo — 500 response

An unexpected error has occurred.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

getUserSessionInfo — 503 response

The service is temporarily unavailable.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

listenEvents — 403 response

Request failed because of invalid data or denied permission.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

listenEvents — 404 response

The requested resource does not exist or is not accessible.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

listenEvents — 500 response

An unexpected error has occurred.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

listenEvents — 503 response

The service is temporarily unavailable.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.