GET /rest/api/2/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 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 required: Administer Projects project permission for the project or Administer Jira global permission.

Servers

Path parameters

Name Type Required Description
id Integer Yes

The ID of the project role. Use Get all project roles to get a list of project role IDs.

projectIdOrKey String Yes

The project ID or project key (case sensitive).

Query parameters

Name Type Required Description
excludeInactiveUsers Boolean No

Exclude inactive users.

Default value: false

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.