Project role actors

Set actors for project role

Changed on

Sets the actors for a project role for a project, replacing all existing actors.

To add actors to the project without overwriting the existing list, use Add actors to project role.

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

put/rest/api/3/project/{projectIdOrKey}/role/{id}

Request

  • Base URL
    https://your-domain.atlassian.net
  • URL
    https://your-domain.atlassian.net/rest/api/3/project/{projectIdOrKey}/role/{id}
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://auth.atlassian.com/authorize
      Token URL: https://auth.atlassian.com/oauth/token scopes: manage:jira-project
    • or 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.

Request body

categorisedActorsobject

The actors to add to the project role.

Add groups using:

  • atlassian-group-role-actor and a list of group names.
  • atlassian-group-role-actor-id and a list of group IDs.

As a group's name can change, use of atlassian-group-role-actor-id is recommended. For example, "atlassian-group-role-actor-id":["eef79f81-0b89-4fca-a736-4be531a10869","77f6ab39-e755-4570-a6ae-2d7a8df0bcb8"].

Add users using atlassian-user-role-actor and a list of account IDs. For example, "atlassian-user-role-actor":["12345678-9abc-def1-2345-6789abcdef12", "abcdef12-3456-789a-bcde-f123456789ab"].

idinteger

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

Response

Returned if the request is successful. The complete list of actors for the project is returned.

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

  • 75c9c58763c9Revision changes
    • warning

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