Skip to main content

Search sessions

POST 
/v2beta/sessions/search

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[]

    userIdQuery

    object

    id string

    creationDateQuery

    object

    creationDate date-time
    method string

    Possible values: [TIMESTAMP_QUERY_METHOD_EQUALS, TIMESTAMP_QUERY_METHOD_GREATER, TIMESTAMP_QUERY_METHOD_GREATER_OR_EQUALS, TIMESTAMP_QUERY_METHOD_LESS, TIMESTAMP_QUERY_METHOD_LESS_OR_EQUALS]

    Default value: TIMESTAMP_QUERY_METHOD_EQUALS

    defines which timestamp comparison method is used

  • ]

    • sortingColumn string

    Possible values: [SESSION_FIELD_NAME_UNSPECIFIED, SESSION_FIELD_NAME_CREATION_DATE]

    Default value: SESSION_FIELD_NAME_UNSPECIFIED

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"

    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"

  • ]

Loading...