ZITADEL Docs
APIsCore ResourcesV1Instance Objects

List instance Members

Deprecated: use ListAdministrators instead.

Members are users with permission to administrate Zitadel on different levels. This request returns all users with memberships on the instance level, matching the search queries. The search queries will be AND linked.

POST
/members/_search

Request Body

application/json

query?

list limitations and ordering

queries?array<|||>

criteria the client is looking for

sortingColumn?string
Value in"MEMBER_FIELD_NAME_UNSPECIFIED" | "MEMBER_FIELD_NAME_USER_ID" | "MEMBER_FIELD_NAME_CREATION_DATE" | "MEMBER_FIELD_NAME_CHANGE_DATE" | "MEMBER_FIELD_NAME_USER_RESOURCE_OWNER"
[key: string]?never

Response Body

application/json

curl -X POST "https://loading/members/_search" \  -H "Content-Type: application/json" \  -d '{}'
{
  "details": {
    "totalResult": 0,
    "processedSequence": 0,
    "viewTimestamp": "2023-01-15T01:30:15.01Z"
  },
  "result": [
    {
      "userId": "string",
      "details": {
        "sequence": 0,
        "creationDate": "2023-01-15T01:30:15.01Z",
        "changeDate": "2023-01-15T01:30:15.01Z",
        "resourceOwner": "string"
      },
      "roles": [
        "string"
      ],
      "preferredLoginName": "string",
      "email": "string",
      "firstName": "string",
      "lastName": "string",
      "displayName": "string",
      "avatarUrl": "string",
      "userType": "TYPE_UNSPECIFIED",
      "userResourceOwner": "string"
    }
  ]
}

Was this page helpful?

List Instance Domains

List Instance Domains: Deprecated: use [instance service v2 GetInstance](/reference/api/system/zitadel.system.v1.SystemService.GetInstance) instead. Returns a list of domains that are configured for this Zitadel instance...

List Instance Trusted Domains

List Instance Trusted Domains: Deprecated: use [instance service v2 ListTrustedDomains](/reference/api/instance/zitadel.instance.v2.InstanceService.ListTrustedDomains) instead. Returns a list of domains that are configured for t...