ZITADEL Docs
APIsCore ResourcesV2Session

List sessions

Searches for sessions matching the given query. You can search by session ID, user ID, creation date, creator, user agent or expiration date.

Required permissions:

  • session.read
  • no permission required to search for own sessions
POST
/v2/sessions/search

Request Body

application/json

query?

List limitations and ordering.

queries?array<|||||>

The criteria to be used when searching for sessions. Multiple queries will be combined with a logical AND.

sortingColumn?string

The column to be used for sorting the sessions.

Value in"SESSION_FIELD_NAME_UNSPECIFIED" | "SESSION_FIELD_NAME_CREATION_DATE"
[key: string]?never

Response Body

application/json

curl -X POST "https://loading/v2/sessions/search" \  -H "Content-Type: application/json" \  -d '{}'
{
  "details": {
    "totalResult": 0,
    "processedSequence": 0,
    "timestamp": "2023-01-15T01:30:15.01Z"
  },
  "sessions": [
    {
      "id": "string",
      "creationDate": "2023-01-15T01:30:15.01Z",
      "changeDate": "2023-01-15T01:30:15.01Z",
      "sequence": 0,
      "factors": {
        "user": {
          "verifiedAt": "2023-01-15T01:30:15.01Z",
          "id": "string",
          "loginName": "string",
          "displayName": "string",
          "organizationId": "string"
        },
        "password": {
          "verifiedAt": "2023-01-15T01:30:15.01Z"
        },
        "webAuthN": {
          "verifiedAt": "2023-01-15T01:30:15.01Z",
          "userVerified": true
        },
        "intent": {
          "verifiedAt": "2023-01-15T01:30:15.01Z"
        },
        "totp": {
          "verifiedAt": "2023-01-15T01:30:15.01Z"
        },
        "otpSms": {
          "verifiedAt": "2023-01-15T01:30:15.01Z"
        },
        "otpEmail": {
          "verifiedAt": "2023-01-15T01:30:15.01Z"
        },
        "recoveryCode": {
          "verifiedAt": "2023-01-15T01:30:15.01Z"
        }
      },
      "metadata": {
        "property1": "string",
        "property2": "string"
      },
      "userAgent": {
        "fingerprintId": "string",
        "ip": "string",
        "description": "string",
        "header": {
          "property1": {
            "values": [
              "string"
            ]
          },
          "property2": {
            "values": [
              "string"
            ]
          }
        }
      },
      "expirationDate": "2023-01-15T01:30:15.01Z"
    }
  ]
}

Was this page helpful?

Get Session

Get Session: Retrieve a session by its ID. Returns all information about the session, including the factors that were verified, the metadata, user agent information and possible expiration date. The session tok...

Set Session

Set Session: Update an existing session with new information like additional checks or metadata or request additional challenges. A new session token will be returned. Note that the previous token will be inval...