List Project Members

List Project Members

POST 
/api/2/auto_eval/project/list_members

List the member roles of the project

Request

application/json

Body

projectId stringrequired

filters

object

query string

search query substring match for member names

projectRole ProjectRole (string)

search only members with the specified project role

Possible values: [PROJECT_ROLE_UNSPECIFIED, PROJECT_ROLE_ADMIN, PROJECT_ROLE_MEMBER, PROJECT_ROLE_CONTRIBUTOR]

pageIndex integer
pageSize integer

Responses

200

Successful operation

application/json

Schema

Schema

projectMembers

object[]

required

Array [

role

object

required

The auth Role for the project member

id integerrequired

name stringrequired

displayName stringrequired

Human-readable display name for the role

roleType RoleType (string)required

Possible values: [ROLE_TYPE_UNSPECIFIED, ROLE_TYPE_USER, ROLE_TYPE_ORGANIZATION, ROLE_TYPE_PROJECT]

roleUsers

object[]

required

Array [

id stringrequired

User id for the user

name stringrequired

email string

profileImageUrl string

]

grantedToRoleIds integer[]required

projectRole ProjectRole (string)required

The role within the project for this member

Possible values: [PROJECT_ROLE_UNSPECIFIED, PROJECT_ROLE_ADMIN, PROJECT_ROLE_MEMBER, PROJECT_ROLE_CONTRIBUTOR]

]

totalCount integerrequired

Total count of project members which can be listed with applicable filters, regardless of page size

Example (from schema)

{
  "projectMembers": [
    {
      "role": {
        "id": 0,
        "name": "string",
        "displayName": "string",
        "roleType": "ROLE_TYPE_UNSPECIFIED",
        "roleUsers": [
          {
            "id": "string",
            "name": "string",
            "email": "string",
            "profileImageUrl": "string"
          }
        ],
        "grantedToRoleIds": [
          0
        ]
      },
      "projectRole": "PROJECT_ROLE_UNSPECIFIED"
    }
  ],
  "totalCount": 0
}

Loading...