Fully update project role

Updates the project role's name and description. You must include both a name and a description in the request.

Permissions required: Administer Jira global permission.

curl --location --request PUT 'http://jira.local:8080/jira/rest//rest/api/3/role/' \ --header 'Content-Type: application/json' \ --data-raw '{ "description": "A project role that represents developers in a project", "name": "Developers" }'

{"self":"https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360","name":"Developers","id":10360,"description":"A project role that represents developers in a project","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"}},{"id":10241,"displayName":"Mia Krystof","type":"atlassian-user-role-actor","actorUser":{"accountId":"5b10a2844c20165700ede21g"}}],"scope":{"type":"PROJECT","project":{"id":"10000","key":"KEY","name":"Next Gen Project"}}}

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

description

string

optional

A description of the project role. Required when fully updating a project role. Optional when creating or partially updating a project role.

name

string

optional

The name of the project role. Must be unique. Cannot begin or end with whitespace. The maximum length is 255 characters. Required when creating a project role. Optional when partially updating a project role.

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 not valid. The `name` cannot be empty or start or end with whitespace.

🟠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.