ZITADEL Docs
APIsCore ResourcesV2Internal Permissions

CreateAdministrator

Create Administrator

CreateAdministrator grants an administrator role to a user for a specific resource.

Note that the roles are specific to the resource type. This means that if you want to grant a user the administrator role for an organization and a project, you need to create two administrator roles.

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/CreateAdministrator

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 who should be granted the administrator role.

resource*|||

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

roles*roles

Roles are the roles that should be granted to the user for the specified resource. Note that roles are currently specific to the resource type. This means that if you want to grant a user the administrator role for an organization and a project, you need to create two administrator roles.

[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://loading/zitadel.internal_permission.v2.InternalPermissionService/CreateAdministrator" \  -H "Connect-Protocol-Version: 1" \  -H "Content-Type: application/json" \  -d '{    "userId": "string",    "resource": {      "instance": true    },    "roles": [      "string"    ]  }'
{
  "creationDate": "1s"
}
{
  "code": "not_found",
  "message": "string",
  "detail": {
    "type": "string",
    "value": "string",
    "debug": {}
  }
}

Was this page helpful?