Classification Level

Cloud

Data Loss Prevention REST API / Reference / REST API

Classification Level

Classification Level APIs"

Operations

GET/orgs/{orgId}/classification-levels POST/orgs/{orgId}/classification-levels GET/orgs/{orgId}/classification-levels/{levelId}PUT/orgs/{orgId}/classification-levels/{levelId}POST/orgs/{orgId}/classification-levels/publish POST/orgs/{orgId}/classification-levels/archive POST/orgs/{orgId}/classification-levels/restore POST/orgs/{orgId}/classification-levels/reorder

GET

Get all classification levels by orgIdExperimental

Gets all classification levels in an organization.

Request

Path parameters

orgId

string

Required

Responses

Returned if the request is successful.

application/json

LevelList

GET/orgs/{orgId}/classification-levels

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'https://api.atlassian.com/admin/dlp/v1/orgs/{orgId}/classification-levels' \
  --header 'Accept: application/json'

200Response

{
  "levels": [
    {
      "levelId": "<string>",
      "orgId": "<string>",
      "name": "<string>",
      "definition": "<string>",
      "guideline": "<string>",
      "color": "RED",
      "sensitivity": 2154,
      "status": "Published",
      "createdBy": {
        "name": "<string>",
        "accountId": "<string>"
      },
      "createdOn": "<string>",
      "changedBy": {
        "name": "<string>",
        "accountId": "<string>"
      },
      "changedOn": "<string>"
    }
  ],
  "links": {
    "first": "<string>",
    "next": "<string>",
    "prev": "<string>"
  }
}

POST

Create a new classification levelExperimental

Creates a draft classification level for an organization.

Request

Path parameters

orgId

string

Required

Request bodyapplication/json

name

string

Required

definition

string

guideline

string

color

LevelColor

Responses

Returned if operation is successful.

application/json

Level

POST/orgs/{orgId}/classification-levels

curl

Node.js

Java

Python

PHP

curl --request POST \
  --url 'https://api.atlassian.com/admin/dlp/v1/orgs/{orgId}/classification-levels' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "definition": "<string>",
  "guideline": "<string>",
  "color": "RED"
}'

202Response

{
  "levelId": "<string>",
  "orgId": "<string>",
  "name": "<string>",
  "definition": "<string>",
  "guideline": "<string>",
  "color": "RED",
  "sensitivity": 2154,
  "status": "Published",
  "createdBy": {
    "name": "<string>",
    "accountId": "<string>"
  },
  "createdOn": "<string>",
  "changedBy": {
    "name": "<string>",
    "accountId": "<string>"
  },
  "changedOn": "<string>"
}

GET

Get a classification levelExperimental

Gets a classification level with the supplied levelId.

Request

Path parameters

levelId

string

Required

orgId

string

Required

Responses

Returned if the request is successful.

application/json

Level

GET/orgs/{orgId}/classification-levels/{levelId}

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'https://api.atlassian.com/admin/dlp/v1/orgs/{orgId}/classification-levels/{levelId}' \
  --header 'Accept: application/json'

200Response

{
  "levelId": "<string>",
  "orgId": "<string>",
  "name": "<string>",
  "definition": "<string>",
  "guideline": "<string>",
  "color": "RED",
  "sensitivity": 2154,
  "status": "Published",
  "createdBy": {
    "name": "<string>",
    "accountId": "<string>"
  },
  "createdOn": "<string>",
  "changedBy": {
    "name": "<string>",
    "accountId": "<string>"
  },
  "changedOn": "<string>"
}

PUT

Edit a classification levelExperimental

Edits a classification level with the supplied levelId.

Request

Path parameters

levelId

string

Required

orgId

string

Required

Request bodyapplication/json

name

string

Required

definition

string

guideline

string

color

LevelColor

Responses

Returned if the request is accepted.

PUT/orgs/{orgId}/classification-levels/{levelId}

curl

Node.js

Java

Python

PHP

curl --request PUT \
  --url 'https://api.atlassian.com/admin/dlp/v1/orgs/{orgId}/classification-levels/{levelId}' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "definition": "<string>",
  "guideline": "<string>",
  "color": "RED"
}'

POST

Publish classification level(s)Experimental

Publishes one or more classification level with the supplied levelIds.

Request

Path parameters

orgId

string

Required

Request bodyapplication/json

levelIds

array<string>

Required

Responses

Returned if the request is accepted.

POST/orgs/{orgId}/classification-levels/publish

curl

Node.js

Java

Python

PHP

curl --request POST \
  --url 'https://api.atlassian.com/admin/dlp/v1/orgs/{orgId}/classification-levels/publish' \
  --header 'Content-Type: application/json' \
  --data '{
  "levelIds": [
    "<string>"
  ]
}'

POST

Archive a data classification levelExperimental

Archives a classification level with the supplied levelId (batch not currently supported). When you archive a published classification level:

Users won’t be able to classify pages at this level
Any page or issues classified at this level will become unclassified
Pages and issues will retain history

In the event that the classification level is restored and published, those pages and issues will regain this classification level.

Request

Path parameters

orgId

string

Required

Request bodyapplication/json

levelIds

array<string>

Required

Responses

Returned if the request is accepted.

POST/orgs/{orgId}/classification-levels/archive

curl

Node.js

Java

Python

PHP

curl --request POST \
  --url 'https://api.atlassian.com/admin/dlp/v1/orgs/{orgId}/classification-levels/archive' \
  --header 'Content-Type: application/json' \
  --data '{
  "levelIds": [
    "<string>"
  ]
}'

POST

Restore a classification levelExperimental

Restores a classification level with supplied levelId. When you restore an archived classification level, it’s restored as a draft.

When you’re ready for your users to start classifying Confluence pages and Jira issues, you can publish the classification level.

If the classification level had been published before being archived, restored, and published again, any pages and issues classified at this level before it was archived will regain this classification level.

Request

Path parameters

orgId

string

Required

Request bodyapplication/json

levelIds

array<string>

Required

Responses

Returned if the request is accepted.

POST/orgs/{orgId}/classification-levels/restore

curl

Node.js

Java

Python

PHP

curl --request POST \
  --url 'https://api.atlassian.com/admin/dlp/v1/orgs/{orgId}/classification-levels/restore' \
  --header 'Content-Type: application/json' \
  --data '{
  "levelIds": [
    "<string>"
  ]
}'

POST

Reorder classification levelsExperimental

Changes the order of classification levels. The most sensitive classification level should be ranked 1.

Request

Path parameters

orgId

string

Required

Request bodyapplication/json

Map<LevelId, Sensitivity>

Key value pair of levelId to sensitivity number

requestedOrder

object

Required

Responses

Returned if the request is accepted.

POST/orgs/{orgId}/classification-levels/reorder

curl

Node.js

Java

Python

PHP

curl --request POST \
  --url 'https://api.atlassian.com/admin/dlp/v1/orgs/{orgId}/classification-levels/reorder' \
  --header 'Content-Type: application/json' \
  --data '{
  "requestedOrder": {
    "ari:cloud:platform::classification-tag/3c3e607b-9e26-4df5-9c4f-bd09dc74404b": 1,
    "ari:cloud:platform::classification-tag/571724a1-8ff7-4f53-acb4-b3480338307e": 2
  }
}'