Appearance
POST
/global/auth/tenants/{tenantId}/users/_inviteRequired scope:
global:user:inviteMails every active user of the tenant who neither signs in with a password nor holds a live invitation a single-use link. Until they use it, they keep signing in as before. Skips users sent too many links recently and users who already have a password and an authenticator. Answers how many were invited and skipped; running it again is safe. Refused while another invitation run is going.
Parameters ​
Path parameters
tenantId stringResponse ​
How many users were invited and skipped.
JSON
{
"invited": 12345,
"unconfirmed": 12345,
"alreadySignedIn": 12345,
"alreadyInvited": 12345,
"managedElsewhere": 12345,
"withCredentials": 12345,
"withoutEmail": 12345,
"throttled": 12345,
"failed": 12345
}
| Error code | Description |
|---|---|
auth.invitation.run-in-progress | Another invitation run is still going; try again when it has finished. |
auth.invitation.tenant-not-found | No live tenant has this id. |