Cloud

Compass / Reference / Compass Operations API

Custom user roles

Operations

GET/v1/roles/{identifier}PUT/v1/roles/{identifier}DEL/v1/roles/{identifier}POST/v1/roles/assign GET/v1/roles POST/v1/roles

GET

Get custom user roleExperimental

Returns details of a custom user role.

The user should have admin role and custom user role right.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

identifier

string

Required

Query parameters

identifierType

string

Responses

Returned if the request is successful.

application/json

GetCustomUserRoleResponse

GET/v1/roles/{identifier}

curl

Node.js

Java

Python

PHP

curl --request GET \
  --url 'https://api.atlassian.com/compass/cloud/{cloudId}/ops/v1/roles/{identifier}' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

200Response

{
  "id": "288c1908-2337-47c0-8a15-9d80fb12aaaa",
  "name": "FinanceRole",
  "extendedRole": "user",
  "grantedRights": [
    "alert-action",
    "alert-create"
  ],
  "disallowedRights": [
    "alert-delete",
    "alert-delete-note",
    "alert-close",
    "alert-close-all"
  ]
}

PUT

Update custom user roleExperimental

Updates the details of a custom user role.

The user should have admin role and custom user role right.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

identifier

string

Required

Query parameters

identifierType

string

Request bodyapplication/json

string

name

string

grantedRights

array<string>

disallowedRights

array<string>

Responses

Returned if the request is successful.

application/json

CustomUserRoleSuccessResponse

PUT/v1/roles/{identifier}

curl

Node.js

Java

Python

PHP

curl --request PUT \
  --url 'https://api.atlassian.com/compass/cloud/{cloudId}/ops/v1/roles/{identifier}' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "conflictRightRole_1",
  "grantedRights": [
    "alerts-access-all",
    "incident-add-note",
    "asdasdad"
  ],
  "disallowedRights": [
    "incident-reopen"
  ]
}'

200Response

{
  "message": "Updated",
  "data": {
    "id": "44a48324-f5f9-45af-b8c9-02978ab0aaaa",
    "name": "FinanceRole"
  }
}

DEL

Delete custom user role.Experimental

Deletes a custom user role.

The user should have admin role and custom user role right.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

identifier

string

Required

Query parameters

identifierType

string

Responses

Returned if the request is successful.

DEL/v1/roles/{identifier}

curl

Node.js

Java

Python

PHP

1
2
3

curl --request DELETE \
  --url 'https://api.atlassian.com/compass/cloud/{cloudId}/ops/v1/roles/{identifier}' \
  --user 'email@example.com:<api_token>'

POST

Assign custom user roleExperimental

Assignes a custom user role to a user.

The user should have admin role and custom user role right.
Assignment on the admin roles can be done through Atlassian Administration.

Forge and OAuth2 apps cannot access this REST resource.

Request

Request bodyapplication/json

accountId

string

Required

roleId

string

Required

Responses

Returned if the request is successful.

application/json

CustomRolesPaginatedResponse

POST/v1/roles/assign

curl

Node.js

Java

Python

PHP

curl --request POST \
  --url 'https://api.atlassian.com/compass/cloud/{cloudId}/ops/v1/roles/assign' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "accountId": "630a55c646556c72662aaaaa",
  "roleId": "44a48324-f5f9-45af-b8c9-02978aaaaaaa"
}'

200Response

{
  "message": "Created",
  "data": {
    "id": "b08dc67b-a19d-4d84-925a-eaa9e13a8aa1",
    "name": "FinanceRole"
  }
}

GET

List custom user rolesExperimental

Returns the list of the custom user roles.

The user should have admin role and custom user role right.

Forge and OAuth2 apps cannot access this REST resource.

Request

Query parameters

offset

integer

size

integer

Responses

Returned if the request is successful.

application/json

PaginatedResponseCustomUserRoleSummaryResponse

GET/v1/roles

curl

Node.js

Java

Python

PHP

curl --request GET \
  --url 'https://api.atlassian.com/compass/cloud/{cloudId}/ops/v1/roles' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

200Response

{
  "values": [
    {
      "id": "288c1908-2337-47c0-8a15-9d80fb1256ea",
      "name": "FinanceRole"
    },
    {
      "id": "2c8f2e0b-4784-4276-a3c9-040e8bc299ab",
      "name": "DeveloperRole"
    },
    {
      "id": "33579c31-627c-4cc1-bb94-fd2c214142f7",
      "name": "SRERole"
    }
  ],
  "links": {
    "next": "/v1/roles?offset=20&size=3",
    "last": "/v1/roles?offset=20&size=3"
  }
}

POST

Create custom user roleExperimental

Creates a new custom user role.

The user should have admin role and custom user role right.

Forge and OAuth2 apps cannot access this REST resource.

Request

Request bodyapplication/json

name

string

Required

grantedRights

array<string>

disallowedRights

array<string>

Responses

Returned if the request is successful.

application/json

CustomUserRoleSuccessResponse

POST/v1/roles

curl

Node.js

Java

Python

PHP

curl --request POST \
  --url 'https://api.atlassian.com/compass/cloud/{cloudId}/ops/v1/roles' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Pre req Rest Api 3",
  "grantedRights": [
    "alert-action",
    "alert-create",
    "alert-add-note"
  ],
  "disallowedRights": [
    "alert-delete"
  ]
}'

200Response

{
  "message": "Created",
  "data": {
    "id": "b08dc67b-a19d-4d84-925a-eaa9e13a8aa1",
    "name": "FinanceRole"
  }
}