Update Project Role

Change a project role. The key is not editable. If a key should change, remove the role and create a new one.

Required permission:

project.role.write

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

TypeScript Definitions

Use the request body type in TypeScript.

projectId*string

ProjectID is the unique identifier of the project.

roleKey*string

RoleKey identifies the role. It's the only relevant attribute for Zitadel and will be used for authorization checks and as claim in tokens and user info responses. It cannot be changed. If you need a different key, remove the role and create a new one.

displayName*|

DisplayName is the human readable name for the role, which might be displayed to users. If omitted, the name will remain unchanged.

group?|

Group allows grouping roles for display purposes. Zitadel will not handle it in any way. It can be used to group roles in a UI to allow easier management for administrators. If omitted, the group will remain unchanged. This attribute is not to be confused with groups as a collection of users.

Response Body

`application/json`

curl -X POST "https://loading/zitadel.project.v2.ProjectService/UpdateProjectRole" \  -H "Connect-Protocol-Version: 1" \  -H "Content-Type: application/json" \  -d '{    "projectId": "string",    "roleKey": "string",    "displayName": "string"  }'

{
  "changeDate": "2023-01-15T01:30:15.01Z"
}

{
  "code": "not_found",
  "message": "string",
  "details": [
    {
      "type": "string",
      "value": "string",
      "debug": {}
    }
  ]
}

Header Parameters

Request Body

Response Body

200application/json

defaultapplication/json

`application/json`

`application/json`