ZITADEL Docs
APIsCore ResourcesV2Internal Permissions

List Administrators

ListAdministrators returns all administrators and their roles matching the request and the caller's permissions to retrieve.

Required permissions depend on the resource type:

  • "iam.member.read" for instance administrators
  • "org.member.read" for organization administrators
  • "project.member.read" for project administrators
  • "project.grant.member.read" for project grant administrators
  • no permissions required for listing own administrator roles
POST
/zitadel.internal_permission.v2.InternalPermissionService/ListAdministrators

Header Parameters

Connect-Protocol-Version*number

Define the version of the Connect protocol

Value in1
Connect-Timeout-Ms?number

Define the timeout, in ms

Request Body

application/json

pagination?|

Paginate through the results using a limit, offset and sorting.

sortingColumn?string

The field the result is sorted by. The default is the creation date. Beware that if you change this, your result pagination might be inconsistent.

Value in"ADMINISTRATOR_FIELD_NAME_UNSPECIFIED" | "ADMINISTRATOR_FIELD_NAME_USER_ID" | "ADMINISTRATOR_FIELD_NAME_CREATION_DATE" | "ADMINISTRATOR_FIELD_NAME_CHANGE_DATE"
filters?array<||||||||||>

Filter the administrator roles to be returned.

[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://loading/zitadel.internal_permission.v2.InternalPermissionService/ListAdministrators" \  -H "Connect-Protocol-Version: 1" \  -H "Content-Type: application/json" \  -d '{}'
{
  "pagination": {
    "totalResult": 0,
    "appliedLimit": 0
  },
  "administrators": [
    {
      "creationDate": "2023-01-15T01:30:15.01Z",
      "changeDate": "2023-01-15T01:30:15.01Z",
      "user": {
        "id": "string",
        "preferredLoginName": "string",
        "displayName": "string",
        "organizationId": "string"
      },
      "roles": [
        "string"
      ],
      "instance": true
    }
  ]
}
{
  "code": "not_found",
  "message": "string",
  "details": [
    {
      "type": "string",
      "value": "string",
      "debug": {}
    }
  ]
}

Was this page helpful?

Delete Administrator

Delete Administrator: DeleteAdministrator revokes an administrator role from a user. In case the administrator role is not found, the request will return a successful response as the desired state is already achieved. Y...

Update Administrator

Update Administrator: UpdateAdministrator updates the specific administrator role. Note that any role previously granted to the user and not present in the request will be revoked. Required permissions depend on the res...