Sign in
Recovery Policy

Create

Create a recovery policy.

post/api/v1/recovery-policies

Request body

allowedRecoveryTypesstring[] nullable

The credential types a user may use to recover access.

displayNamestring required

A human-readable name for the policy.

minRecoveryAuthLevel'AUTH_LEVEL_UNSPECIFIED' | 'AUTH_LEVEL_NONE' | 'AUTH_LEVEL_SINGLE_FACTOR' | 'AUTH_LEVEL_MULTI_FACTOR' | 'AUTH_LEVEL_PHR' | 'AUTH_LEVEL_PHRH'

The minimum assurance level a recovery ceremony must reach.

priorityinteger

When a user matches more than one policy, the policy with the highest priority applies.

revokeOnRecoveryboolean

When true, a successful recovery revokes existing credentials and forces re-enrollment.

Response

Successful response

Changes

Changed in 1 of the 34 revisions of this API.1