Organisations
Read an organisation's classification settings
The default label of a new diagram, the folders with a default of their own, and "Share only diagrams labelled Public".
GET
/orgs/{org}/classificationTL;DR
| Question | Answer |
|---|---|
| What does it do? | Read an organisation's classification settings. |
| What does it take? | org in the path. |
| What does it return? | Status 200 with a body of type OrganisationClassification. |
| What can go wrong? | 401 not signed in; 404 no such organisation, or the caller is not a member of it; 429 too many requests; 503 organisations are not set up on this server. Every failure uses the one error envelope. |
What it does
The default label of a new diagram, the folders with a default of their own, and "Share only diagrams labelled Public". Any member may read them.
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation's id or its slug. |
Responses
| Status | Meaning | Body |
|---|---|---|
| 200 | The settings. | OrganisationClassification |
| 401 | Not signed in. | ErrorResponse |
| 404 | No such organisation, or the caller is not a member of it. | ErrorResponse |
| 429 | Too many requests. | ErrorResponse |
| 503 | Organisations are not set up on this server. | ErrorResponse |
Response body
A 200 answer has the type OrganisationClassification.
| Field | Type | Required | Description |
|---|---|---|---|
default | Classification | yes | A diagram's classification label: public, internal (the default, and what a diagram published before labels reads as) or confidential. Confidential is never shared publicly; under "Share only diagrams labelled Public" only public is. |
sharePublicOnly | boolean | yes | "Share only diagrams labelled Public": while true, only a diagram labelled public may have a public link. The owner's setting. |
folders | object[] | yes | The folders with a default label of their own. A new diagram filed in one, or in a folder inside it, gets it; the deepest wins. |
folders[].folder | string | yes | at least 1 character; at most 300 characters. |
folders[].classification | Classification | yes | A diagram's classification label: public, internal (the default, and what a diagram published before labels reads as) or confidential. Confidential is never shared publicly; under "Share only diagrams labelled Public" only public is. |
See also
| Doc | Why |
|---|---|
| API reference | Every endpoint, and the error envelope |
| Schemas | Every request and response type |
| Tool reference | The operations as callable tools |