Skip to main content

Get a session​

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

Path Parameters
    sessionId string required
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"

GET /v2beta/sessions/:sessionId

Authorization

name: OAuth2type: oauth2scopes: openid,urn:zitadel:iam:org:project:id:zitadel:audflows: {
  "authorizationCode": {
    "authorizationUrl": "$CUSTOM-DOMAIN/oauth/v2/authorize",
    "tokenUrl": "$CUSTOM-DOMAIN/oauth/v2/token",
    "scopes": {
      "openid": "openid",
      "urn:zitadel:iam:org:project:id:zitadel:aud": "urn:zitadel:iam:org:project:id:zitadel:aud"
    }
  }
}

Request

Base URL
https://$CUSTOM-DOMAIN
Bearer Token
sessionId — path required
sessionToken — query
Accept
curl / cURL
curl -L -X GET 'https://$CUSTOM-DOMAIN/v2beta/sessions/:sessionId' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'