ZITADEL Docs
APIsCore ResourcesV2Internal Permissions

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 resource type:

  • "iam.member.write" for instance administrators
  • "org.member.write" for organization administrators
  • "project.member.write" for project administrators
  • "project.grant.member.write" for project grant administrators
POST
/zitadel.internal_permission.v2.InternalPermissionService/UpdateAdministrator

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

userId?string

UserID is the ID of the user whose administrator roles should be updated.

resource*|||

Resource is the type of the resource the administrator roles should be granted for.

roles?array<>

Roles are the roles that the user should be granted. Note that any role previously granted to the user and not present in the list will be revoked.

[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://loading/zitadel.internal_permission.v2.InternalPermissionService/UpdateAdministrator" \  -H "Connect-Protocol-Version: 1" \  -H "Content-Type: application/json" \  -d '{    "resource": {      "instance": true    }  }'
{
  "changeDate": "2023-01-15T01:30:15.01Z"
}
{
  "code": "not_found",
  "message": "string",
  "details": [
    {
      "type": "string",
      "value": "string",
      "debug": {}
    }
  ]
}

Was this page helpful?

List Administrators

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:

Auth API

Explore the Auth API operation in the ZITADEL API. Learn about request parameters, response schemas, and integration details for this endpoint.