Skip to main content

Search sessions​

Search for sessions

Request Body required
  • query object

    Object unspecific list filters like offset, limit and asc/desc.

  • offset uint64
  • limit int64

    Maximum amount of events returned. The default is set to 1000 in https://github.com/zitadel/zitadel/blob/new-eventstore/cmd/zitadel/startup.yaml. If the limit exceeds the maximum configured ZITADEL will throw an error. If no limit is present the default is taken.

  • asc boolean

    default is descending

  • queries object[]
  • Array [
  • idsQuery object
  • ids string[]
  • ]
Responses

OK

Schema
  • details object
  • totalResult uint64
  • processedSequence uint64
  • timestamp date-time

    the last time the projection got updated

  • sessions object[]
  • Array [
  • 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"

  • password object
  • verifiedAt date-time

    "time when the password was last checked"

  • metadata object

    "custom key value list"

  • property name* string
  • ]
POST /v2alpha/sessions/_search

Request

Base URL
https://$ZITADEL_DOMAIN
Content-Type
Body required
{

  "query": {

    "offset": "0",

    "limit": 100,

    "asc": true

  },

  "queries": [

    {

      "idsQuery": {

        "ids": [

          "string"

        ]

      }

    }

  ]

}
Accept
curl -L -X POST 'https://$ZITADEL_DOMAIN/v2alpha/sessions/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "query": {
    "offset": "0",
    "limit": 100,
    "asc": true
  },
  "queries": [
    {
      "idsQuery": {
        "ids": [
          "string"
        ]
      }
    }
  ]
}'