Sign in
Project roles

Get project role details

Returns all project roles and the details for each role. Note that the list of project roles is common to all projects.

This operation can be accessed anonymously.

Permissions required: Administer Jira global permission or Administer projects project permission for the project.

get/rest/api/2/project/{projectIdOrKey}/roledetails

Path parameters

projectIdOrKeystring required

The project ID or project key (case sensitive).

Query parameters

currentMemberboolean

Whether the roles should be filtered to include only those the user is assigned to.

excludeConnectAddonsboolean
excludeOtherServiceRolesboolean

Do not return the default JSM company-managed space from CSM spaces, or the default CSM roles from JSM spaces.

Response

Returned if the request is successful.

adminboolean

Whether this role is the admin role for the project.

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.

type'DEFAULT' | 'GUEST_ROLE' | 'AI_AGENT_ROLE'

The type of the project role. This is "DEFAULT" or "GUEST_ROLE".

Changes

Changed in 1 of the 15 revisions of this API.1

  • 38a98954789e1See the full diff
    • ●

      added the new product_discovery enum value to the items/scope/allOf[Scope]/project/allOf[ProjectDetails]/projectTypeKey response property for the response status 200

      response-property-enum-value-added