Project roles

Get project role for project

Changed on

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.

get/rest/api/2/project/{projectIdOrKey}/role/{id}

Request

  • Base URL: https://your-domain.atlassian.net
  • URL: https://your-domain.atlassian.net/rest/api/2/project/{projectIdOrKey}/role/{id}
  • Auth: one of:
    • HTTP basic
    • OAuth 2 (authorization code, authorization URL https://auth.atlassian.com/authorize, token URL https://auth.atlassian.com/oauth/token, scopes: read:jira-work)
    • none

Path parameters

projectIdOrKeystring required

The project ID or project key (case sensitive).

idinteger required

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

Query parameters

excludeInactiveUsersboolean

Exclude inactive users.

Response

Returned if the request is successful.

adminboolean

Whether this role is the admin role for the project.

currentUserRoleboolean

Whether the calling user is part of this role.

defaultboolean

Whether this role is the default role for the project

descriptionstring

The description of the project role.

idinteger

The ID of the project role.

namestring

The name of the project role.

roleConfigurableboolean

Whether the roles are configurable for this project.

selfstring uri

The URL the project role details.

translatedNamestring

The translated name of the project role.

Changes

  • 38a98954789eRevision changes
    • warning

      added the new product_discovery enum value to the ////////// response property for the response status