New Ory Agent Security is now live! Claim your complimentary test drive. Get Started!

Skip to main content

recoveryCodesUsage()

function recoveryCodesUsage(nodes: UiNode[]): undefined | OryRecoveryCodesUsage

Returns how many recovery codes the user has left.

Revealed codes take precedence over the lookup_secret_remaining node, so the count always matches the codes on screen.

Parameters​

ParameterTypeDescription
nodesUiNode[]The nodes of the lookup_secret group.

Returns​

| undefined | OryRecoveryCodesUsage

The usage, or undefined while regenerated codes await confirmation or when Ory sent no usable count.