provider Project roles GET /rest/api/3/project/{projectIdOrKey}/role/{id}
@utdk/jira /rest/api/3/project/{projectIdOrKey}/role/{id}
Get project role for project
Returns a project role's details and actors associated with the project. The list of actors is sorted by display name. To check whether a user belongs to a role based on their group memberships, use [Get user](#api-rest-api-3-user-get) with the `groups` expand parameter selected. Then check whether the user keys and groups match with the actors returned for the project. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project or *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
projectIdOrKey path required
The project ID or project key (case sensitive).
string
id path required
The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs.
integer
excludeInactiveUsers query
Exclude inactive users.
boolean

Try it

Authentication
Configure credentials for The Jira Cloud platform REST API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

getprojectrole
GET/rest/api/3/project/{projectIdOrKey}/role/{id}
Returns a project role's details and actors associated with the project. The list of actors is sorted by display name. To check whether a user belongs to a role based on their group memberships, use [Get user](#api-rest-api-3-user-get) with the `groups` expand parameter selected. Then check whether the user keys and groups match with the actors returned for the project. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project or *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters

required

The project ID or project key (case sensitive).

required

The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs.

Exclude inactive users.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import jira from '@utdk/jira';

await jira.getprojectrole({
  "excludeInactiveUsers": false
})