ListProjectRoles

List Project Roles

Returns all roles of a project matching the search query.

Required permission:

project.role.read

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.

pagination?

Pagination can be used to list limitations and ordering.

sortingColumn?string

SortingColumn is the field the result is sorted by. The default is the creation date. Beware that if you change this, your result pagination might be inconsistent.

Value in

"PROJECT_ROLE_FIELD_NAME_UNSPECIFIED" | "PROJECT_ROLE_FIELD_NAME_KEY" | "PROJECT_ROLE_FIELD_NAME_CREATION_DATE" | "PROJECT_ROLE_FIELD_NAME_CHANGE_DATE"

filters?

Filters define the criteria to query for.

[key: string]?never

Response Body

`application/json`

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

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

{
  "pagination": {
    "totalResult": 0,
    "appliedLimit": 0
  },
  "projectRoles": [
    {
      "projectId": "string",
      "key": "string",
      "creationDate": "1s",
      "changeDate": "1s",
      "displayName": "string",
      "group": "string"
    }
  ]
}

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

ListProjectRoles

Header Parameters

Request Body

Response Body

200application/json

defaultapplication/json

`application/json`

`application/json`