ZITADEL Docs
APIsCore ResourcesV2Project

Add Project Role

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

Required permission:

  • project.role.write
POST
/zitadel.project.v2.ProjectService/AddProjectRole

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?|

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

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"  }'
{
  "creationDate": "2023-01-15T01:30:15.01Z"
}
{
  "code": "not_found",
  "message": "string",
  "details": [
    {
      "type": "string",
      "value": "string",
      "debug": {}
    }
  ]
}

Was this page helpful?

Activate Project Grant

Activate Project Grant: Set the state of the project grant to activated. Required permission:

Create Project

Create Project: Create a new project. A project is a vessel to group applications, roles and authorizations. Every project belongs to exactly one organization, but can be granted to other organizations for self-ma...