ZITADEL Docs
APIsCore ResourcesV1Instance Lifecycle

ListIAMMembers

Returns all instance members matching the request all queries need to match (ANDed) Deprecated: Use the Admin APIs ListIAMMembers instead

POST
/instances/{instance_id}/members/_search

Path Parameters

instance_id*string

Request Body

application/json

query?
queries?
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

application/json

curl -X POST "https://loading/instances/string/members/_search" \  -H "Content-Type: application/json" \  -d '{}'
{
  "details": {
    "totalResult": 0,
    "processedSequence": 0,
    "viewTimestamp": "1s"
  },
  "result": [
    {
      "userId": "string",
      "details": {
        "sequence": 0,
        "creationDate": "1s",
        "changeDate": "1s",
        "resourceOwner": "string"
      },
      "roles": [
        "string"
      ],
      "preferredLoginName": "string",
      "email": "string",
      "firstName": "string",
      "lastName": "string",
      "displayName": "string",
      "avatarUrl": "string",
      "userType": "TYPE_UNSPECIFIED",
      "userResourceOwner": "string"
    }
  ]
}
{
  "code": "not_found",
  "message": "string",
  "detail": {
    "type": "string",
    "value": "string",
    "debug": {}
  }
}

Was this page helpful?