AddProjectRole

Add Project Role

Add a new project role to a project. The key must be unique within the project.

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

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.

displayName*string

DisplayName is a human readable name for the role, which might be displayed to users.

group?string

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. This attribute is not to be confused with groups as a collection of users.

[key: string]?never

Response Body

`application/json`

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

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

{
  "creationDate": "1s"
}

{
  "code": "not_found",
  "message": "string",
  "detail": {
    "type": "string",
    "value": "string",
    "debug": {}
  }
}

AddProjectRole

Header Parameters

Request Body

Response Body

200application/json

defaultapplication/json

`application/json`

`application/json`