Cloud
Jira Service Management ops / Reference / REST API

Team roles

Postman Collection
OpenAPI
GET

Get Team roleExperimental

Returns details of a team role.

read:ops-config:jira-service-management

Request

Path parameters

teamId

string

Required
identifier

string

Required

Responses

Returned if the request is successful.

application/json

TeamRoleResponse
GET/v1/teams/{teamId}/roles/{identifier}
1 2 3 4 curl --request GET \ --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/teams/{teamId}/roles/{identifier}' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 { "id": "f120cc2d-255f-4bfd-967f-ea236a294b3e", "name": "teamRole1", "rights": [ { "right": "access-reports", "granted": true }, { "right": "delete-escalations", "granted": true }, { "right": "delete-heartbeats", "granted": true }, { "right": "delete-integrations", "granted": true }, { "right": "delete-maintenance", "granted": true }, { "right": "delete-policies", "granted": true }, { "right": "delete-routing-rules", "granted": true }, { "right": "delete-schedules", "granted": true }, { "right": "delete-team-roles", "granted": false }, { "right": "edit-escalations", "granted": true }, { "right": "edit-heartbeats", "granted": true }, { "right": "edit-integrations", "granted": true }, { "right": "edit-maintenance", "granted": true }, { "right": "edit-policies", "granted": true }, { "right": "edit-routing-rules", "granted": true }, { "right": "edit-schedules", "granted": true }, { "right": "edit-team-roles", "granted": true } ] }
DEL

Delete a team role.Experimental

Deletes a team role.

read:ops-config:jira-service-management
,
delete:ops-config:jira-service-management

Request

Path parameters

identifier

string

Required
teamId

string

Required

Responses

Returned if the request is successful.

DEL/v1/teams/{teamId}/roles/{identifier}
1 2 3 curl --request DELETE \ --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/teams/{teamId}/roles/{identifier}' \ --user 'email@example.com:<api_token>'
PATCH

Update team roleExperimental

Updates the details of a team role

read:ops-config:jira-service-management
,
write:ops-config:jira-service-management

Request

Path parameters

identifier

string

Required
teamId

string

Required

Request bodyapplication/json

name

string

rights

array<object>

Responses

Returned if the request is successful.

application/json

TeamRoleResponse
PATCH/v1/teams/{teamId}/roles/{identifier}
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 curl --request PATCH \ --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/teams/{teamId}/roles/{identifier}' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "name": "updatedRole", "rights": [ { "right": "access-reports", "granted": true }, { "right": "delete-escalations", "granted": false } ] }'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 { "id": "f120cc2d-255f-4bfd-967f-ea236a294b3e", "name": "teamRole1", "rights": [ { "right": "access-reports", "granted": true }, { "right": "delete-escalations", "granted": true }, { "right": "delete-heartbeats", "granted": true }, { "right": "delete-integrations", "granted": true }, { "right": "delete-maintenance", "granted": true }, { "right": "delete-policies", "granted": true }, { "right": "delete-routing-rules", "granted": true }, { "right": "delete-schedules", "granted": true }, { "right": "delete-team-roles", "granted": false }, { "right": "edit-escalations", "granted": true }, { "right": "edit-heartbeats", "granted": true }, { "right": "edit-integrations", "granted": true }, { "right": "edit-maintenance", "granted": true }, { "right": "edit-policies", "granted": true }, { "right": "edit-routing-rules", "granted": true }, { "right": "edit-schedules", "granted": true }, { "right": "edit-team-roles", "granted": true } ] }
GET

List Team rolesExperimental

Returns list of team roles.

read:ops-config:jira-service-management

Request

Path parameters

teamId

string

Required

Responses

Returned if the request is successful.

application/json

array<object>

GET/v1/teams/{teamId}/roles
1 2 3 4 curl --request GET \ --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/teams/{teamId}/roles' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 [ { "id": "68200526-6e67-44e2-8507-1f2aad059478", "name": "role2", "rights": [ { "right": "access-reports", "granted": true }, { "right": "delete-escalations", "granted": false }, { "right": "delete-heartbeats", "granted": false }, { "right": "delete-integrations", "granted": false }, { "right": "delete-maintenance", "granted": false }, { "right": "delete-policies", "granted": false }, { "right": "delete-routing-rules", "granted": false }, { "right": "delete-schedules", "granted": false }, { "right": "delete-team-roles", "granted": false }, { "right": "edit-escalations", "granted": false }, { "right": "edit-heartbeats", "granted": false }, { "right": "edit-integrations", "granted": false }, { "right": "edit-maintenance", "granted": false }, { "right": "edit-policies", "granted": false }, { "right": "edit-routing-rules", "granted": false }, { "right": "edit-schedules", "granted": false }, { "right": "edit-team-roles", "granted": false } ] }, { "id": "711420e9-bd64-4a7f-86a5-c62a6d837e24", "name": "role3", "rights": [ { "right": "access-reports", "granted": false }, { "right": "delete-escalations", "granted": false }, { "right": "delete-heartbeats", "granted": false }, { "right": "delete-integrations", "granted": false }, { "right": "delete-maintenance", "granted": false }, { "right": "delete-policies", "granted": false }, { "right": "delete-routing-rules", "granted": false }, { "right": "delete-schedules", "granted": false }, { "right": "delete-team-roles", "granted": false }, { "right": "edit-escalations", "granted": false }, { "right": "edit-heartbeats", "granted": false }, { "right": "edit-integrations", "granted": false }, { "right": "edit-maintenance", "granted": false }, { "right": "edit-policies", "granted": false }, { "right": "edit-routing-rules", "granted": false }, { "right": "edit-schedules", "granted": false }, { "right": "edit-team-roles", "granted": false } ] } ]
POST

Create team roleExperimental

Creates a team role

read:ops-config:jira-service-management
,
write:ops-config:jira-service-management

Request

Path parameters

teamId

string

Required

Request bodyapplication/json

name

string

rights

array<object>

Responses

Returned if the request is successful.

application/json

TeamRoleResponse
POST/v1/teams/{teamId}/roles
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 curl --request POST \ --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/teams/{teamId}/roles' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "name": "createRole", "rights": [ { "right": "access-reports", "granted": true }, { "right": "delete-escalations", "granted": false } ] }'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 { "id": "f120cc2d-255f-4bfd-967f-ea236a294b3e", "name": "teamRole1", "rights": [ { "right": "access-reports", "granted": true }, { "right": "delete-escalations", "granted": true }, { "right": "delete-heartbeats", "granted": true }, { "right": "delete-integrations", "granted": true }, { "right": "delete-maintenance", "granted": true }, { "right": "delete-policies", "granted": true }, { "right": "delete-routing-rules", "granted": true }, { "right": "delete-schedules", "granted": true }, { "right": "delete-team-roles", "granted": false }, { "right": "edit-escalations", "granted": true }, { "right": "edit-heartbeats", "granted": true }, { "right": "edit-integrations", "granted": true }, { "right": "edit-maintenance", "granted": true }, { "right": "edit-policies", "granted": true }, { "right": "edit-routing-rules", "granted": true }, { "right": "edit-schedules", "granted": true }, { "right": "edit-team-roles", "granted": true } ] }

Rate this page: