Type Alias CognitoAccountSecurityDeps

The reference server side of CognitoAccountSecurityActions: server-only, framework-free. Every call acts on the session's own login with its access token. A federated session may manage only its passkeys: its IdP owns the password and second factor.

type CognitoAccountSecurityDeps = {
    recordPasskeyEnrollment: RecordPasskeyEnrollment;
    totpIssuer: string;
    accountAccess(): Promise<CognitoAccountAccess | null>;
    afterPasswordChange(
        input: { cognitoSub: CognitoIdentity["sub"] },
    ): Promise<void>;
    endSession(): Promise<void>;
    qrPngBase64(otpauthUri: string): Promise<string>;
    reportError(error: unknown): void;
}

Index

Properties

recordPasskeyEnrollment totpIssuer

Methods

accountAccess afterPasswordChange endSession qrPngBase64 reportError

Properties

recordPasskeyEnrollment

recordPasskeyEnrollment: RecordPasskeyEnrollment

Runs after each passkey change, with Cognito's list after it.

totpIssuer

totpIssuer: string

The authenticator app's name for the entry, e.g. "CFX".

Methods

accountAccess

accountAccess(): Promise<CognitoAccountAccess | null>
The request's session, as readCognitoAccountAccess reads its cookies.

Returns Promise<CognitoAccountAccess | null>
- Defined in packages/ui/src/lib/cognito-account-security-server.ts:35

afterPasswordChange

afterPasswordChange(
input: { cognitoSub: CognitoIdentity["sub"] },
): Promise<void>
Runs once Cognito has accepted a new password: the dashboard ends the login's other sessions.
Parameters
- input: { cognitoSub: CognitoIdentity["sub"] }
Returns Promise<void>
- Defined in packages/ui/src/lib/cognito-account-security-server.ts:47

endSession

endSession(): Promise<void>
Ends the request's stored session and clears its cookies.

Returns Promise<void>
- Defined in packages/ui/src/lib/cognito-account-security-server.ts:37

qrPngBase64

qrPngBase64(otpauthUri: string): Promise<string>
The otpauth URI's QR code as a base64 PNG.
Parameters
- otpauthUri: string
Returns Promise<string>
- Defined in packages/ui/src/lib/cognito-account-security-server.ts:41

reportError

reportError(error: unknown): void
A failure that isn't a refusal: the screen says "try again", this says why.
Parameters
- error: unknown
Returns void
- Defined in packages/ui/src/lib/cognito-account-security-server.ts:45

Type Alias CognitoAccountSecurityDeps

Index

Properties

Methods

Properties

recordPasskeyEnrollment

totpIssuer

Methods

accountAccess

Returns Promise<CognitoAccountAccess | null>

afterPasswordChange

Parameters

Returns Promise<void>

endSession

Returns Promise<void>

qrPngBase64

Parameters

Returns Promise<string>

reportError

Parameters

Returns void

Settings

On This Page