Last updated Jun 17, 2024

Data classification cookbook

Overview

The data classification feature enables organizations to categorize content into classes defined by their data classification policy, known as classification levels. These levels, set up by organization admins, apply organization-wide. The feature extends to setting default levels for Confluence spaces and Jira projects. This guide outlines the process of creating classification levels and classifying Confluence spaces and Jira projects.

Create a classification level

POST /orgs/{orgId}/classification-levels

Create a classification level for the whole organization in accordance with your company policy.

1
2
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"
}'

Save the levelId from the response of this call to use later. Show me details on creating a classification level.

Publish a classification level

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

When data classification levels are configured, they are initially stored as drafts. Publish classification levels so they are available to be applied to company data.

1
2
curl --request POST \
  --url 'https://api.atlassian.com/admin/dlp/v1/orgs/{orgId}/classification-levels/publish' \
  --header 'Content-Type: application/json' \
  --data '{
  "levelIds": [
    "ari:cloud:platform::classification-tag/dec24c48-5073-4c25-8fef-9d81a992c30c",
    "ari:cloud:platform::classification-tag/dec24c48-5073-4c25-8fef-9d81a992c30c",
  ]
}'

Show me details on publishing a classification level.

Retrieve a list of projects/spaces

GET /rest/api/3/project/search (Jira) GET /spaces (Confluence)

In order to update the default classification level of a project or space, you must first obtain its Id. To retrieve a list of projects or spaces use the following APIs:

1
2
# This will retrieve list of projects in organization Jira instance
curl --request GET \
  --url 'https://your-domain.atlassian.net/rest/api/3/project/search' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'
1
2
# This will retrieve list of spaces in organization Confluence instance  
curl --request GET \
  --url 'https://your-domain.atlassian.net/wiki/api/v2/spaces' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

Explore Get Jira projects and Get Confluence spaces APIs.

Update default classification level

PUT /rest/api/3/project/{projectIdOrKey}/classification-level/default (Jira) PUT /wiki/api/v2/spaces/{id}/classification-level/default (Confluence)

Update the default classification level of a project or space to the desired classification level. Permissions and scopes differ between Jira and Confluence compared to Cloud Admin. Please refer to the linked APIs for more information.

1
2
# Updating default classification level for a Jira project
curl --request PUT \
  --url 'https://your-domain.atlassian.net/rest/api/3/project/{projectIdOrKey}/classification-level/default' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "ari:cloud:platform::classification-tag/dec24c48-5073-4c25-8fef-9d81a992c30c"
}'
1
2
# Updating default classification level for a Confluence space
curl --request PUT \
  --url 'https://your-domain.atlassian.net/wiki/api/v2/spaces/{spaceId}/classification-level/default' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "ari:cloud:platform::classification-tag/dec24c48-5073-4c25-8fef-9d81a992c30c"
}'

Explore Update the default data classification level of a project and Update space default classification level APIs.

Rate this page: