method

RiduAuth.forceUnlock

Clear lockout state for an auth user when authorized.

Arguments

Argument	Type	Description
`input`	`{ id: string; } & AuthCollectionInput<DefaultAuth, Slug>`	The locked user ID and optional collection.
`options`	`RequestOptions \| undefined`	Request options.

Returns

The declared result.

Promise<AuthActionEnvelope>

Full signature

RiduAuth.forceUnlock<
	Slug extends AuthCollectionSlug<Config> = SessionCollection<Config, DefaultAuth>,
>(
	input: { id: string; } & AuthCollectionInput<DefaultAuth, Slug>,
	options?: RequestOptions,
): Promise<AuthActionEnvelope>

Source packages/sdk/src/types.ts:1663

Related types

AuthCollectionSlug
Collection slugs with the generated auth capability.
SessionCollection
Auth collections a client's sessions can belong to: its default, or every auth collection.
AuthCollectionInput
Selects the auth collection for one call. It is optional only when the client was created with auth.collection, which becomes Default; otherwise every call names its collection.
RequestOptions
Options shared by every request.
AuthActionEnvelope
A successful auth maintenance action.