<access-service>/api/v1/organisations/{orgId}/labels/{labelId}

​

URL structure

https://access-service.xy-company.com/api/v1/organisations/{orgId}/labels/{labelId}

​

Supported methods and overview

• GET - used to retrieve information about a classification (specified by labelId) configured in an organization (specified by orgId).
• DELETE - used to delete an existing classification (specified by labelId) in an organization (specified by orgId).

​

Detailed description

• Retrieves information about a classification (specified by labelId) configured in an organization (specified by orgId). A classification’s ID can be obtained by calling the GET method of the <access-service>/api/v1/organisations/{orgId}/labels API endpoint, which retrieves a list of information for all classifications configured in an organization (specified by orgId).
  Tip: All information (except the description member) returned in the response from a GET method call to this API endpoint is also returned in the response from a GET method call to the <access-service>/api/v1/organisations/{orgId}/labels endpoint. Therefore, if you do not require a classification’s description when retrieving information about the classification, there is no need to call the GET method on this API endpoint.
• Deletes an existing classification (specified by labelId) from an organization (specified by orgId).
  Important: Deleting a classification also removes:
  • this classification from all new and existing file objects it had been applied to and more importantly,
  • removes all current collaborators from these file objects.

​

Supported roles and conditions

• Organization administrator, Originator, Collaborator, Ad hoc - using the GET method, when this user is a member of the organization specified by the {orgId} of the request’s URL.
• Organization administrator - using the DELETE method, when this user is a member of the organization specified by the {orgId} of the request’s URL.

​

Required headers

• Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE0NjcwMTY2NjYsInVzZXJfbmFtZSI6ImFsZXgub...

​

Returns

• id - The ID of the classification.
• name - The name of the classification.
• description - The description of the classification.
• priority - The current priority value, which is used for sorting classifications from highest (i.e. a priority integer value of 1) through to the lowest priority (i.e. the highest priority integer value, which equals the total number of all classifications defined in an organization).
• applyI18n - .
  Example (response):
  {
      "id": "766855749304623104",
      "name": {
          "value": "Confidential"
      },
      "description": {
          "value": "This classification level is used for content that should only be accessible to members of staff with security clearance. Anyone outside the company (including partners) should not access this content."
      },
      "priority": "1",
      "applyI18n": false
  }