Add default actors to project role

Adds default actors to a role. You may add groups or users, but you cannot add groups and users in the same request.

Changing a project role's default actors does not affect project role members for projects already created.

Permissions required: Administer Jira global permission.

{"actors":[{"id":10240,"displayName":"jira-developers","type":"atlassian-group-role-actor","name":"jira-developers","actorGroup":{"name":"jira-developers","displayName":"jira-developers","groupId":"952d12c3-5b5b-4d04-bb32-44d383afc4b2"}}]}

Request

Path Params

integer

required

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

Body Params application/json

group

array[string]

optional

The name of the group to add as a default actor. This parameter cannot be used with the groupId parameter. As a group's name can change,use of groupId is recommended. This parameter accepts a comma-separated list. For example, "group":["project-admin", "jira-developers"].

groupId

array[string]

optional

The ID of the group to add as a default actor. This parameter cannot be used with the group parameter This parameter accepts a comma-separated list. For example, "groupId":["77f6ab39-e755-4570-a6ae-2d7a8df0bcb8", "0c011f85-69ed-49c4-a801-3b18d0f771bc"].

user

array[string]

optional

The account IDs of the users to add as default actors. This parameter accepts a comma-separated list. For example, "user":["5b10a2844c20165700ede21g", "5b109f2e9729b51b54dc274d"].

Examples

Responses

🟢200Returned if the request is successful.

application/json

Body

Details about the roles in a project.

actors

array[object (RoleActor) {7}]

read-onlyoptional

The list of users who act in this role.

actorGroup

object

read-onlyoptional

Details of the group associated with the role.

actorUser

object

read-onlyoptional

Details of the user associated with the role.

avatarUrl

string <uri>

read-onlyoptional

The avatar of the role actor.

displayName

string

read-onlyoptional

The display name of the role actor. For users, depending on the user’s privacy setting, this may return an alternative value for the user's name.

integer <int64>

read-onlyoptional

The ID of the role actor.

name

string

read-onlyoptional

This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.

type

enum<string>

read-onlyoptional

The type of role actor.

Allowed values:

atlassian-group-role-actoratlassian-user-role-actor

admin

boolean

read-onlyoptional

Whether this role is the admin role for the project.

currentUserRole

boolean

optional

Whether the calling user is part of this role.

default

boolean

read-onlyoptional

Whether this role is the default role for the project

description

string

read-onlyoptional

The description of the project role.

integer <int64>

read-onlyoptional

The ID of the project role.

name

string

optional

The name of the project role.

roleConfigurable

boolean

read-onlyoptional

Whether the roles are configurable for this project.

scope

object

read-onlyoptional

The scope of the role. Indicated for roles associated with next-gen projects.

project

object

read-onlyoptional

The project the item has scope in.

type

enum<string>

read-onlyoptional

The type of scope.

Allowed values:

PROJECTTEMPLATE

Additional properties

integer | number | string | boolean

optional

self

string <uri>

read-onlyoptional

The URL the project role details.

translatedName

string

optional

The translated name of the project role.

🟠400Returned if the request is invalid.

🟠401Returned if the authentication credentials are incorrect or missing.

🟠403Returned if the user does not have administrative permissions.

🟠404Returned if the project role is not found.