Get all the ProjectRoles available in Jira. Currently this list is global.
Forge and OAuth2 apps cannot access this REST resource.
This request has no parameters.
Returns full details of the roles available in Jira.
1
2
3
4
curl --request GET \
--url 'http://{baseurl}/rest/api/2/role' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
{
"actors": [
{
"name": "jira-developers"
}
],
"description": "A project role that represents developers in a project",
"id": 10360,
"name": "Developers",
"self": "http://www.example.com/jira/rest/api/2/project/MKY/role/10360"
}Creates a new ProjectRole to be available in Jira. The created role does not have any default actors assigned.
Forge and OAuth2 apps cannot access this REST resource.
The role to create
string
string
Returns full details of the created role
1
2
3
4
5
6
7
8
9
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' \
--data '{
"description": "role description",
"name": "MyRole"
}'1
2
3
4
5
6
7
8
9
10
11
{
"actors": [
{
"name": "jira-developers"
}
],
"description": "A project role that represents developers in a project",
"id": 10360,
"name": "Developers",
"self": "http://www.example.com/jira/rest/api/2/project/MKY/role/10360"
}Get a specific ProjectRole available in Jira.
Forge and OAuth2 apps cannot access this REST resource.
integer
RequiredReturns full details of the role available in Jira.
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'1
2
3
4
5
6
7
8
9
10
11
{
"actors": [
{
"name": "jira-developers"
}
],
"description": "A project role that represents developers in a project",
"id": 10360,
"name": "Developers",
"self": "http://www.example.com/jira/rest/api/2/project/MKY/role/10360"
}Fully updates a roles. Both name and description must be given.
Forge and OAuth2 apps cannot access this REST resource.
integer
Requiredstring
string
Returns updated role.
1
2
3
4
5
6
7
8
9
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' \
--data '{
"description": "role description",
"name": "MyRole"
}'1
2
3
4
5
6
7
8
9
10
11
{
"actors": [
{
"name": "jira-developers"
}
],
"description": "A project role that represents developers in a project",
"id": 10360,
"name": "Developers",
"self": "http://www.example.com/jira/rest/api/2/project/MKY/role/10360"
}Partially updates a roles name or description.
Forge and OAuth2 apps cannot access this REST resource.
integer
Requiredstring
string
Returns updated role.
1
2
3
4
5
6
7
8
9
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' \
--data '{
"description": "role description",
"name": "MyRole"
}'1
2
3
4
5
6
7
8
9
10
11
{
"actors": [
{
"name": "jira-developers"
}
],
"description": "A project role that represents developers in a project",
"id": 10360,
"name": "Developers",
"self": "http://www.example.com/jira/rest/api/2/project/MKY/role/10360"
}Deletes a role. May return 403 in the future
Forge and OAuth2 apps cannot access this REST resource.
integer
Requiredinteger
Returned if the delete was successful.
1
2
3
curl --request DELETE \
--url 'http://{baseurl}/rest/api/2/role/{id}' \
--user 'email@example.com:<api_token>'Gets default actors for the given role.
Forge and OAuth2 apps cannot access this REST resource.
integer
RequiredReturns actor list.
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'1
2
3
4
5
6
7
{
"actors": [
{
"name": "jira-developers"
}
]
}Adds default actors to the given role. The request data should contain a list of usernames or a list of groups to add.
Forge and OAuth2 apps cannot access this REST resource.
integer
Requiredarray<string>
array<string>
Returns actor list.
1
2
3
4
5
6
7
8
9
10
11
12
13
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' \
--data '{
"group": [
"<string>"
],
"user": [
"<string>"
]
}'1
2
3
4
5
6
7
{
"actors": [
{
"name": "jira-developers"
}
]
}Removes default actor from the given role.
Forge and OAuth2 apps cannot access this REST resource.
integer
Requiredstring
string
Returns updated actors list.
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'1
2
3
4
5
6
7
{
"actors": [
{
"name": "jira-developers"
}
]
}Rate this page: