Skip to content

Users

users_sessions_get

Read one end-user session in full: its status, device metadata, both expiries, the assurance level and factors it was established with, why it was revoked if it was, and the operator behind it if it is an impersonated session.

Tool

users_sessions_get

Read one end-user session in full: its status, device metadata, both expiries, the assurance level and factors it was established with, why it was revoked if it was, and the operator behind it if it is an impersonated session.

Read one end-user session in full: its status, device metadata, both expiries, the assurance level and factors it was established with, why it was revoked if it was, and the operator behind it if it is an impersonated session.

Behavior

HTTP
GET /users/sessions/:sessionId

Arguments

NameTypeRequiredDescription
sessionIdstringThe session to read.

Response

FieldTypeAlwaysDescription
idstring
ipstring
aalstring`aal2` only if a verified second factor completed.
amrarrayThe factors this session was established with.
statusstring
userIdstring
createdAtstring
expiresAtstring
revokedAtstring
userAgentstring
revokedReasonstring
impersonatedBystringThe operator behind an impersonated session, or null for an ordinary one.
lastRefreshedAtstring
absoluteExpiresAtstring

Try it

Read one end-user session in full: its status, device metadata, both expiries, the assurance level and factors it was established with, why it was revoked if it was, and the operator behind it if it is an impersonated session.

When to use

Read one end-user session in full: its status, device metadata, both expiries, the assurance level and factors it was established with, why it was revoked if it was, and the operator behind it if it is an impersonated session.

Example

Ask your agent something like this:

Read one end-user session in full: its status, device metadata, both expiries, the assurance level and factors it was established with, why it was revoked if it was, and the operator behind it if it is an impersonated session.

The agent will invoke users_sessions_get with these arguments:

{
  "sessionId": "<sessionId>"
}

Esc

Start typing to search the docs.

navigateselect