Skip to main content

Returns all instance members matching the request​

all queries need to match (ANDed)

Returns all instance members matching the request all queries need to match (ANDed)

Path Parameters
  • instanceId string required
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 [
  • firstNameQuery object
  • firstName string

    Possible values: <= 200 characters

  • method string

    Possible values: [TEXT_QUERY_METHOD_EQUALS, TEXT_QUERY_METHOD_EQUALS_IGNORE_CASE, TEXT_QUERY_METHOD_STARTS_WITH, TEXT_QUERY_METHOD_STARTS_WITH_IGNORE_CASE, TEXT_QUERY_METHOD_CONTAINS, TEXT_QUERY_METHOD_CONTAINS_IGNORE_CASE, TEXT_QUERY_METHOD_ENDS_WITH, TEXT_QUERY_METHOD_ENDS_WITH_IGNORE_CASE]

    Default value: TEXT_QUERY_METHOD_EQUALS

    defines which text equality method is used

  • lastNameQuery object
  • lastName string

    Possible values: <= 200 characters

  • method string

    Possible values: [TEXT_QUERY_METHOD_EQUALS, TEXT_QUERY_METHOD_EQUALS_IGNORE_CASE, TEXT_QUERY_METHOD_STARTS_WITH, TEXT_QUERY_METHOD_STARTS_WITH_IGNORE_CASE, TEXT_QUERY_METHOD_CONTAINS, TEXT_QUERY_METHOD_CONTAINS_IGNORE_CASE, TEXT_QUERY_METHOD_ENDS_WITH, TEXT_QUERY_METHOD_ENDS_WITH_IGNORE_CASE]

    Default value: TEXT_QUERY_METHOD_EQUALS

    defines which text equality method is used

  • emailQuery object
  • email string

    Possible values: <= 200 characters

    email address of the user. (spec: https://tools.ietf.org/html/rfc2822#section-3.4.1)

  • method string

    Possible values: [TEXT_QUERY_METHOD_EQUALS, TEXT_QUERY_METHOD_EQUALS_IGNORE_CASE, TEXT_QUERY_METHOD_STARTS_WITH, TEXT_QUERY_METHOD_STARTS_WITH_IGNORE_CASE, TEXT_QUERY_METHOD_CONTAINS, TEXT_QUERY_METHOD_CONTAINS_IGNORE_CASE, TEXT_QUERY_METHOD_ENDS_WITH, TEXT_QUERY_METHOD_ENDS_WITH_IGNORE_CASE]

    Default value: TEXT_QUERY_METHOD_EQUALS

    defines which text equality method is used

  • userIdQuery object
  • userId string

    Possible values: <= 200 characters

    the id of the user

  • ]
Responses

A successful response.

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

    the last time the view got updated

  • result object[]
  • Array [
  • userId string
  • details object
  • sequence uint64

    on read: the sequence of the last event reduced by the projection

    on manipulation: the timestamp of the event(s) added by the manipulation

  • creationDate date-time

    on read: the timestamp of the first event of the object

    on create: the timestamp of the event(s) added by the manipulation

  • changeDate date-time

    on read: the timestamp of the last event reduced by the projection

    on manipulation: the

  • resourceOwner resource_owner is the organization an object belongs to
  • roles string[]

    the role keys granted to the user

  • preferredLoginName string

    preferred login name of the user

  • email string

    preferred login name of the user

  • firstName string

    the first name of the user

  • lastName string

    last name of the user

  • displayName string

    display name of the user

  • avatarUrl string

    avatar URL of the user

  • userType string

    Possible values: [TYPE_UNSPECIFIED, TYPE_HUMAN, TYPE_MACHINE]

    Default value: TYPE_UNSPECIFIED

    type of the user (human / machine)

  • ]
POST /instances/:instanceId/members/_search

Request

Base URL
https://$ZITADEL_DOMAIN/system/v1
instanceId — path required
Content-Type
Body required
{

  "query": {

    "offset": "0",

    "limit": 100,

    "asc": true

  },

  "queries": [

    {

      "firstNameQuery": {

        "firstName": "Gigi",

        "method": "TEXT_QUERY_METHOD_EQUALS"

      },

      "lastNameQuery": {

        "lastName": "Giraffe",

        "method": "TEXT_QUERY_METHOD_EQUALS"

      },

      "emailQuery": {

        "email": "gigi@zitadel.com",

        "method": "TEXT_QUERY_METHOD_EQUALS"

      },

      "userIdQuery": {

        "userId": "69629023906488334"

      }

    }

  ]

}
Accept
curl -L -X POST 'https://$ZITADEL_DOMAIN/system/v1/instances/:instanceId/members/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "query": {
    "offset": "0",
    "limit": 100,
    "asc": true
  },
  "queries": [
    {
      "firstNameQuery": {
        "firstName": "Gigi",
        "method": "TEXT_QUERY_METHOD_EQUALS"
      },
      "lastNameQuery": {
        "lastName": "Giraffe",
        "method": "TEXT_QUERY_METHOD_EQUALS"
      },
      "emailQuery": {
        "email": "gigi@zitadel.com",
        "method": "TEXT_QUERY_METHOD_EQUALS"
      },
      "userIdQuery": {
        "userId": "69629023906488334"
      }
    }
  ]
}'