This resource represents classification levels used in a project. Use it to view and manage classification levels in your projects.

Hierarchy

  • CommonHttpService
    • ProjectClassificationLevelsService

Constructors

Methods

  • Returns the default data classification for a project.

    Permissions required:

    Parameters

    • params: {
          projectIdOrKey: string;
      }
      • projectIdOrKey: string

        The project ID or project key (case-sensitive).

    Returns Promise<unknown>

    Returned if the request is successful.

    example:

    {
    "classification": {
    "id": "ari:cloud:platform::classification-tag/5bfa70f7-4af1-44f5-9e12-1ce185f15a38",
    "status": "published",
    "name": "Restricted",
    "rank": 1,
    "description": "Data we hold that would be very damaging and would cause loss of trust with customers and present legal risk if mishandled",
    "guideline": "Access to data must be restricted to only individuals who need access in order to perform their job duties.",
    "guidelineADF": "{\"version\":1,\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Access to data must be restricted to only individuals who need access in order to perform their job duties.\"}]}]}",
    "color": "RED"
    }
    }

    GET /rest/api/3/project/{projectIdOrKey}/classification-level/default @scopes-current read:jira-work @scopes-beta read:project:jira

  • Returns the consolidated classification configuration for a project's admin settings page.

    This includes permitted classification levels (with status), the project's default classification level, the organization's default classification level, and the container override setting.

    Permissions required:

    Parameters

    • params: {
          projectIdOrKey: string;
      }
      • projectIdOrKey: string

        The project ID or project key (case-sensitive).

    Returns Promise<unknown>

    Returned if the request is successful.

    example:

    {
    "classificationLevels": [
    {
    "id": "ari:cloud:platform::classification-tag/5bfa70f7-4af1-44f5-9e12-1ce185f15a38",
    "status": "published",
    "name": "Restricted",
    "rank": 1,
    "description": "Data we hold that would be very damaging and would cause loss of trust with customers and present legal risk if mishandled",
    "guideline": "Access to data must be restricted to only individuals who need access in order to perform their job duties.",
    "color": "RED"
    }
    ],
    "containerOverride": "ANY",
    "defaultClassificationLevel": {
    "id": "ari:cloud:platform::classification-tag/5bfa70f7-4af1-44f5-9e12-1ce185f15a38",
    "status": "published",
    "name": "Restricted",
    "rank": 1,
    "description": "Data we hold that would be very damaging and would cause loss of trust with customers and present legal risk if mishandled",
    "guideline": "Access to data must be restricted to only individuals who need access in order to perform their job duties.",
    "color": "RED"
    },
    "organizationClassificationLevel": {
    "id": "ari:cloud:platform::classification-tag/a82d653e-1035-4aa2-b9de-4265511fd487",
    "status": "published",
    "name": "Confidential",
    "rank": 2,
    "description": "Data we hold that would likely be damaging and could cause loss of trust with our customers if mishandled",
    "guideline": "Data should be encrypted at rest and in transit.",
    "color": "BLUE"
    }
    }

    GET /rest/api/3/project/{projectIdOrKey}/classification-config @scopes-current read:jira-work @scopes-beta read:project:jira

  • Method to initialize the class. Normally used to set up validation rules.

    Returns void