v4

latestOpenAPI 3.0.1Apache 2.02026-08-016079122.3 MB

Project roles

Partial update project role

Updates either the project role's name or its description.

You cannot update both the name and description at the same time using this operation. If you send a request with a name and a description only the name is updated.

Permissions required: Administer Jira global permission.

post/rest/api/2/role/{id}

Path parameters

idinteger required

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

Request body

descriptionstring

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

namestring

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.

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.