Organisations
Read the organisation's sign-in security
Whether every member must have two-step sign-in on, since when, and how many members have it.
GET
/orgs/{org}/securityTL;DR
| Question | Answer |
|---|---|
| What does it do? | Read the organisation's sign-in security. |
| What does it take? | org in the path. |
| What does it return? | Status 200 with a body of type OrgSecurity. |
| What can go wrong? | 401 not signed in; 403 the organisation requires two-step sign-in and this account does not have it on (orgs.two_factor_required); 404 no such organisation, or the caller is not a member of it; 429 too many requests. Every failure uses the one error envelope. |
What it does
Whether every member must have two-step sign-in on, since when, and how many members have it. The owner and the admins also get the members without it.
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation's id or its slug. |
Responses
| Status | Meaning | Body |
|---|---|---|
| 200 | The organisation's security. | OrgSecurity |
| 401 | Not signed in. | ErrorResponse |
| 403 | The organisation requires two-step sign-in and this account does not have it on (orgs.two_factor_required). | ErrorResponse |
| 404 | No such organisation, or the caller is not a member of it. | ErrorResponse |
| 429 | Too many requests. | ErrorResponse |
Response body
A 200 answer has the type OrgSecurity.
| Field | Type | Required | Description |
|---|---|---|---|
requireTwoFactor | boolean | yes | Whether every member must have two-step sign-in on to use the organisation. |
since | integer | null | yes | When it was turned on, in milliseconds since the epoch, or null. |
canManage | boolean | yes | Whether the caller may change it: the owner and the admins. |
members | object | yes | |
members.total | integer | yes | |
members.withTwoFactor | integer | yes | |
without | object[] | yes | The members without two-step sign-in, for the owner and the admins; empty for anyone else. At most 200. |
without[].userId | string | yes | |
without[].email | string | yes | |
without[].name | string | null | yes | |
without[].role | string | yes | |
without[].remindedAt | integer | null | yes |
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 |