Atlassian: Get all classification levels

Atlassian classificationLevels.getAllUserDataClassificationLevels: arguments, response, policy and SDK examples.

← Classification levels operations · Get started

Operation atlassian.getalluserdataclassificationlevels

Provider route: GET /{cloudId}/rest/api/3/classification-levels. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/atlassian with npm, or alter-sdk-atlassian with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { AtlassianIntegration } from "@alter-ai/atlassian";

async function execute(input: Parameters<AtlassianIntegration["classificationLevels"]["getAllUserDataClassificationLevels"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new AtlassianIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.classificationLevels.getAllUserDataClassificationLevels(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_atlassian import AtlassianIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = AtlassianIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.classification_levels.get_all_user_data_classification_levels(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`path`	object	Required within parent	Additional keys: not allowed
`path.cloudId`	string	Required within parent	Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
`query`	object	Optional	Additional keys: not allowed
`query.status`	array	Optional	Unique items: true
`query.status[]`	string	Each item	The status of the project classification. Default: One of: PUBLISHED, ARCHIVED, DRAFT
`query.orderBy`	string	Optional	One of: rank, -rank, +rank

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
`$`	Model	Root	Expand Get all classification levels — response body

Referenced models: Get all classification levels — response body

Schemas

Get all classification levels — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	The data classification.
`classifications`	JSON	Optional
`classifications (anyOf 1)`	array	Alternative	The data classifications.
`classifications (anyOf 1)[]`	Model	Each item	Expand Get all classification levels — response body — classifications The data classifications item
`classifications (anyOf 2)`	null	Alternative

Referenced models: Get all classification levels — response body — classifications The data classifications item

Get all classification levels — response body — classifications The data classifications item

Field	Type	Presence	Description and constraints
`$`	object	Root	The data classification.
`color`	JSON	Optional
`color (anyOf 1)`	string	Alternative	The color of the data classification object.
`color (anyOf 2)`	null	Alternative
`description`	JSON	Optional
`description (anyOf 1)`	string	Alternative	The description of the data classification object.
`description (anyOf 2)`	null	Alternative
`guideline`	JSON	Optional
`guideline (anyOf 1)`	string	Alternative	The guideline of the data classification object.
`guideline (anyOf 2)`	null	Alternative
`guidelineADF`	JSON	Optional
`guidelineADF (anyOf 1)`	string	Alternative	The guideline in ADF (Atlassian Document Format) for rich text rendering.
`guidelineADF (anyOf 2)`	null	Alternative
`id`	JSON	Optional
`id (anyOf 1)`	string	Alternative	The ID of the data classification object.
`id (anyOf 2)`	null	Alternative
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative	The name of the data classification object.
`name (anyOf 2)`	null	Alternative
`rank`	JSON	Optional
`rank (anyOf 1)`	JSON	Alternative
`rank (anyOf 1) (anyOf 1)`	integer	Alternative	The rank of the data classification object. Format: int32
`rank (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`rank (anyOf 2)`	null	Alternative
`status`	JSON	Optional
`status (anyOf 1)`	string	Alternative	The status of the data classification object.
`status (anyOf 2)`	null	Alternative

Policy, approvals and errors

SDK function policy ID: atlassian.getalluserdataclassificationlevels. Catalog operation: getalluserdataclassificationlevels. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["read:jira-work"]

Official provider source

Report an issue with this page