Account
The account a site belongs to, the people who can reach it, and the invitations that add them. An account is the unit everything else hangs from — sites, quota and billing are all per account rather than per person.
Renames the account being acted on.
Renames the account being acted on. › Request Body
nameWhat to call the account, or null to clear the name.
Renames the account being acted on. › Responses
OK
accountIdIts ULID.
kindWhether it belongs to one person or is shared.
nameWhat it calls itself, or null when nobody has named it.
Invites somebody onto the account and returns the link once.
Invites somebody onto the account and returns the link once. › Request Body
emailAddress to invite. Compared against the accepter's own before they are let in.
roleWhat accepting grants: Owner or Member. Absent means member.
Absent rather than required, and defaulting to the lesser of the two, because an omitted field must not hand out authority nobody asked for — the same rule every capability column on a plan follows.
Invites somebody onto the account and returns the link once. › Responses
OK
acceptUrlThe link. Returned here and nowhere else — only its hash is stored, so this response is the one chance to copy it, which is what lets an owner pass it on when mail does not arrive.
emailThe address it was sent to.
expiresAtWhen it stops working.
idIts id, for revoking.
Lists who is on the account and which invitations still stand.
Lists who is on the account and which invitations still stand. › Responses
OK
Invitations still standing. Spent and withdrawn ones are history, not a list.
People who may act on it, oldest first.
requireTwoFactorAtSince when the owner has required two-factor of every member, or null while they have not.
tokensOfUnprotectedMembers^-?(?:0|[1-9]\d*)$ · requiredAccess tokens on this account held by members without two-factor. Requiring two-factor does not stop them, so the owner is told before turning it on.
Changes what somebody on the account may do.
path Parameters
userIdChanges what somebody on the account may do. › Request Body
roleThe role to give them: Owner or Member.
Changes what somebody on the account may do. › Responses
OK
emailTheir address, which is how a colleague recognises them.
founderWhether they created the account. A founder cannot be removed or demoted while the plan is held in their name, so the members screen offers neither for this row.
joinedAtWhen they were added.
nameTheir display name, or null when Google gave none.
roleWhat they may do here.
twoFactorWhether they have two-factor on — the column an owner reads before requiring it, and a member reads to see whether the rule would block them.
userIdTheir ULID, which is what removing them names.
Starts or stops requiring two-factor.
Members without two-factor are refused from their next request. Access tokens they already made keep working.
Starts or stops requiring two-factor. › Request Body
requireTwoFactorWhether every member must sign in with two-factor.
Starts or stops requiring two-factor. › Responses
OK
requireTwoFactorAtSince when two-factor is required, or null while it is not.
Lists the accounts the signed-in person may act on.
Lists the accounts the signed-in person may act on. › Responses
OK
Every account the caller may act on, oldest membership first. Never empty for a signed-in person: signing in creates an account for them, and they are its owner.
Joins the account an invitation link names.
Joins the account an invitation link names. › Request Body
tokenThe token from the invitation link.
Joins the account an invitation link names. › Responses
OK
accountIdThe account they are now a member of.
accountNameWhat it calls itself, or null when nobody has named it.
requiresTwoFactorWhether the account joined requires two-factor, so the page can say so before the gate does (IMPLEMENTATION-PLAN §5.3.6).
roleWhat they may do there.