Skip to content
Connect an agent

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/reminders

TL;DR

QuestionAnswer
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

FieldTypeRequiredDescription
orgstringyesThe organisation's id or its slug.

Request body

The body has the type RemindTwoFactorBody.

FieldTypeRequiredDescription
userIdsstring[]noThe members to remind. Left out, every member without two-step sign-in.

Responses

StatusMeaningBody
200Who was reminded and who was skipped.TwoFactorReminders
400The body is not valid.ErrorResponse
401Not signed in.ErrorResponse
403Only the owner or an admin may (orgs.forbidden), or the origin may not make changes.ErrorResponse
404No such organisation, or the caller is not a member of it.ErrorResponse
429Too many requests.ErrorResponse
502An email could not be sent.ErrorResponse

Response body

A 200 answer has the type TwoFactorReminders.

FieldTypeRequiredDescription
sentstring[]yesThe members a reminder went to.
skippedobject[]yesMembers reminded less than a day before, and when they can be reminded again.
skipped[].userIdstringyes
skipped[].nextAtintegeryes

See also

DocWhy
API referenceEvery endpoint, and the error envelope
SchemasEvery request and response type
Tool referenceThe operations as callable tools