Organisations
Remind members to turn on two-step sign-in
Emails the named members, or every member without two-step sign-in, a reminder.
POST
/orgs/{org}/security/remindersTL;DR
| Question | Answer |
|---|---|
| What does it do? | Remind members to turn on two-step sign-in. |
| What does it take? | A JSON body of type RemindTwoFactorBody. |
| What does it return? | Status 200 with a body of type TwoFactorReminders. |
| What can go wrong? | 400 the body is not valid; 401 not signed in; 403 only the owner or an admin may (orgs.forbidden), or the origin may not make changes; 404 no such organisation, or the caller is not a member of it; 429 too many requests; 502 an email could not be sent. Every failure uses the one error envelope. |
What it does
Emails the named members, or every member without two-step sign-in, a reminder. Each member at most once a day. Owner and admins only.
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation's id or its slug. |
Request body
The body has the type RemindTwoFactorBody.
| Field | Type | Required | Description |
|---|---|---|---|
userIds | string[] | no | The members to remind. Left out, every member without two-step sign-in. |
Responses
| Status | Meaning | Body |
|---|---|---|
| 200 | Who was reminded and who was skipped. | TwoFactorReminders |
| 400 | The body is not valid. | ErrorResponse |
| 401 | Not signed in. | ErrorResponse |
| 403 | Only the owner or an admin may (orgs.forbidden), or the origin may not make changes. | ErrorResponse |
| 404 | No such organisation, or the caller is not a member of it. | ErrorResponse |
| 429 | Too many requests. | ErrorResponse |
| 502 | An email could not be sent. | ErrorResponse |
Response body
A 200 answer has the type TwoFactorReminders.
| Field | Type | Required | Description |
|---|---|---|---|
sent | string[] | yes | The members a reminder went to. |
skipped | object[] | yes | Members reminded less than a day before, and when they can be reminded again. |
skipped[].userId | string | yes | |
skipped[].nextAt | integer | 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 |