Sign in

v1

latestOpenAPI 3.1.02026-07-24261240.7 KB
Roles

Get Project Role

Returns the requested project role.

Security: Requires Platform Admin or Project Admin privileges.

get/access/api/v1/projects/{projectKey}/roles/{role}

Path parameters

projectKeystring required

The project key

rolestring required

The role name

Response

Success

namestring

Role name

descriptionstring

Role description

type'PREDEFINED' | 'CUSTOM' | 'CUSTOM_GLOBAL'

Role type. PREDEFINED = built-in role, CUSTOM = project-scoped custom role, CUSTOM_GLOBAL = global custom role.

environmentsstring[]

Environments for the role

actionsstring[]

Actions permitted by this role