Skip to main content

Get a session

GET 
https://$CUSTOM-DOMAIN/v2/sessions/:sessionId

Get a session and all its information like the time of the user or password verification

Request​

Path Parameters

    sessionId stringrequired

Query Parameters

    sessionToken string

Responses​

OK

Schema

    session

    object

    id string

    "id of the session"

    creationDate date-time

    "time when the session was created"

    changeDate date-time

    "time when the session was last updated"

    sequence uint64

    "sequence of the session"

    factors

    object

    "checked factors of the session, e.g. the user, password and more"

    user

    object

    verifiedAt date-time

    "time when the user was last checked"

    id string

    "id of the checked user"

    loginName string

    "login name of the checked user"

    displayName string

    "display name of the checked user"

    organizationId string

    "organization id of the checked user"

    password

    object

    verifiedAt date-time

    "time when the password was last checked"

    webAuthN

    object

    verifiedAt date-time

    "time when the passkey challenge was last checked"

    userVerified boolean

    intent

    object

    verifiedAt date-time

    "time when an intent was last checked"

    totp

    object

    verifiedAt date-time

    "time when the Time-based One-Time Password was last checked"

    otpSms

    object

    verifiedAt date-time

    "time when the One-Time Password was last checked"

    otpEmail

    object

    verifiedAt date-time

    "time when the One-Time Password was last checked"

    metadata

    object

    "custom key value list"

    property name* byte

    userAgent

    object

    fingerprintId string
    ip string
    description string

    header

    object

    property name*

    object

    A header may have multiple values. In Go, headers are defined as map[string][]string, but protobuf doesn't allow this scheme.

    values string[]
    expirationDate date-time

    "time the session will be automatically invalidated"

curl -L 'https://$CUSTOM-DOMAIN/v2/sessions/:sessionId' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
Request Collapse all
Base URL
https://$CUSTOM-DOMAIN
Auth
Parameters
— pathrequired
— query
ResponseClear

Click the Send API Request button above and see the response here!