Server
Jira Data Center / Reference / REST API

role

Postman Collection
Operations
GET/api/2/rolePOST/api/2/roleGET/api/2/role/{id}PUT/api/2/role/{id}POST/api/2/role/{id}DEL/api/2/role/{id}GET/api/2/role/{id}/actorsPOST/api/2/role/{id}/actorsDEL/api/2/role/{id}/actors
GET

Get all project roles

Get all the ProjectRoles available in Jira. Currently this list is global.

Request

This request has no parameters.

Responses

Returns full details of the roles available in Jira.

application/json

ProjectRoleBean
GET/api/2/role
1 2 3 4 curl --request GET \ --url 'http://{baseurl}/rest/api/2/role' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
POST

Create a new project role

Creates a new ProjectRole to be available in Jira. The created role does not have any default actors assigned.

Request

Request bodyapplication/json

The role to create

description

string

name

string

Responses

Returns full details of the created role

application/json

ProjectRoleBean
POST/api/2/role
1 2 3 4 5 curl --request POST \ --url 'http://{baseurl}/rest/api/2/role' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json'
GET

Get a specific project role

Get a specific ProjectRole available in Jira.

Request

Path parameters

id

integer

Required

Responses

Returns full details of the role available in Jira.

application/json

ProjectRoleBean
GET/api/2/role/{id}
1 2 3 4 curl --request GET \ --url 'http://{baseurl}/rest/api/2/role/{id}' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
PUT

Fully updates a role's name and description

Fully updates a roles. Both name and description must be given.

Request

Path parameters

id

integer

Required

Request bodyapplication/json

description

string

name

string

Responses

Returns updated role.

application/json

ProjectRoleBean
PUT/api/2/role/{id}
1 2 3 4 5 curl --request PUT \ --url 'http://{baseurl}/rest/api/2/role/{id}' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json'
POST

Partially updates a role's name or description

Partially updates a roles name or description.

Request

Path parameters

id

integer

Required

Request bodyapplication/json

description

string

name

string

Responses

Returns updated role.

application/json

ProjectRoleBean
POST/api/2/role/{id}
1 2 3 4 5 curl --request POST \ --url 'http://{baseurl}/rest/api/2/role/{id}' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json'
DEL

Deletes a role

Deletes a role. May return 403 in the future

Request

Path parameters

id

integer

Required

Query parameters

swap

integer

Responses

Returned if the delete was successful.

DEL/api/2/role/{id}
1 2 3 curl --request DELETE \ --url 'http://{baseurl}/rest/api/2/role/{id}' \ --user 'email@example.com:<api_token>'
GET

Get default actors for a role

Gets default actors for the given role.

Request

Path parameters

id

integer

Required

Responses

Returns actor list.

application/json

ProjectRoleActorsBean
GET/api/2/role/{id}/actors
1 2 3 4 curl --request GET \ --url 'http://{baseurl}/rest/api/2/role/{id}/actors' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
POST

Adds default actors to a role

Adds default actors to the given role. The request data should contain a list of usernames or a list of groups to add.

Request

Path parameters

id

integer

Required

Request bodyapplication/json

group

array<string>

user

array<string>

Responses

Returns actor list.

application/json

ProjectRoleActorsBean
POST/api/2/role/{id}/actors
1 2 3 4 5 curl --request POST \ --url 'http://{baseurl}/rest/api/2/role/{id}/actors' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json'
DEL

Removes default actor from a role

Removes default actor from the given role.

Request

Path parameters

id

integer

Required

Query parameters

user

string

group

string

Responses

Returns updated actors list.

application/json

ProjectRoleActorsBean
DEL/api/2/role/{id}/actors
1 2 3 4 curl --request DELETE \ --url 'http://{baseurl}/rest/api/2/role/{id}/actors' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'

Rate this page: