RecoveryCompleted
The RecoveryCompleted type of the TypeScript SDK, which passwords.reset take or answer.
type RecoveryCompleted = {
appPasswordsRevoked: number
created: boolean
credentialIds: string[]
mailboxId: string
recoveryAddressVerified?: boolean
reset: true
sessionsRevoked: number
usernames: string[]
}Fields
| Field | Type | Description |
|---|---|---|
appPasswordsRevoked | number | Non-expiring app passwords revoked. Zero unless the caller asked for it |
created | boolean | True when the mailbox had no password credential and the reset established one |
credentialIds | string[] | Every password credential now carrying the new secret |
mailboxId | string | The identity whose password was reset |
recoveryAddressVerified | boolean | Optional. Present on the invitation branch only (§XVII): true when the nominated address was promoted to this mailbox's verified recovery address in the same act. False when the account's policy is admin_only, which means the address was used once as a delivery destination and never stored. That is the one outcome the redeeming user could not otherwise discover, since it turns on a tenant policy they have never heard of |
reset | true | The password was set |
sessionsRevoked | number | Expiring credentials revoked by the reset (browser sessions and other dated credentials) |
usernames | string[] | Every username those credentials answer to. More than one means two logins now share this password, which the frontend must say out loud |
Used by
| Method | What it does |
|---|---|
passwords.reset | Reset a mailbox password as an administrator |