Get organization settings

GET 
/v2/orgs/:org_id/data-classification-settings

Retrieves board classification settings for an existing organization.

Required scope

organizations:read

Rate limiting

Level 2

Enterprise only

This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using this form.

Request

Path Parameters

org_id stringrequired
id of the organization
Example: 3074457345821141000

Responses

200

Organization board classification settings

application/json

Schema

Schema

enabled boolean

Data classification enabled for organization

labels

object[]

Data classification labels

Array [

id string

Label id.

color string

Label color.

default boolean

Label is default.

description string

Label description.

name string

Label name.

orderNumber int32

Label order number.

sharingRecommendation string

Sharing Recommendation (one of NO_SHARING_RESTRICTIONS, ONLY_WITHIN_ORGANIZATION, ONLY_WITHIN_TEAM or ONLY_WITH_AUTHORIZED_TEAM_MEMBERS ).

guidelineUrl string

Indicates the URL for the board classification label guidelines.

type string

Default value: data-classification-label

Type of the object returned.

]

type string

Default value: data-classification-organization-settings

Type of the object returned.

Example (from schema)

{
  "enabled": true,
  "labels": [
    {
      "id": "3000457366756290996",
      "color": "#F5DC80",
      "default": false,
      "description": "Board could not be shared publicly",
      "name": "internal",
      "orderNumber": 2,
      "sharingRecommendation": "NO_SHARING_RESTRICTIONS",
      "guidelineUrl": "https://miro.com",
      "type": "data-classification-label"
    }
  ],
  "type": "data-classification-organization-settings"
}

400

Malformed request

application/json

Schema

Schema

status number

Default value: 400

HTTP status code.

code string

Default value: invalidParameters

Description of the status code.

message string

Explanation for the error

type string

Default value: error

Type of the object returned.

Example (from schema)

{
  "status": 400,
  "code": "invalidParameters",
  "message": "string",
  "type": "error"
}

401

Invalid authentication credentials

application/json

Schema

Schema

status number

Default value: 401

HTTP status code.

code string

Default value: tokenNotProvided

Description of the status code.

message string

Explanation for the error

type string

Default value: error

Type of the object returned.

Example (from schema)

{
  "status": 401,
  "code": "tokenNotProvided",
  "message": "string",
  "type": "error"
}

403

Invalid access

application/json

Schema

Schema

status number

Default value: 403

HTTP status code.

code string

Default value: forbiddenAccess

Description of the status code.

message string

Explanation for the error

type string

Default value: error

Type of the object returned.

Example (from schema)

{
  "status": 403,
  "code": "forbiddenAccess",
  "message": "string",
  "type": "error"
}

404

Invalid access

application/json

Schema

Schema

status number

Default value: 404

HTTP status code.

code string

Default value: notFound

Description of the status code.

message string

Explanation for the error

type string

Default value: error

Type of the object returned.

Example (from schema)

{
  "status": 404,
  "code": "notFound",
  "message": "string",
  "type": "error"
}

429

Too many requests

application/json

Schema

Schema

status number

Default value: 429

HTTP status code.

code string

Default value: tooManyRequests

Description of the status code.

message string

Explanation for the error

type string

Default value: error

Type of the object returned.

Example (from schema)

{
  "status": 429,
  "code": "tooManyRequests",
  "message": "string",
  "type": "error"
}

Loading...