Class DashboardSsoUserAdminService

A dashboard user's Cognito sign-in links, for CFX operators offboarding a deleted SSO connection. Records no activity, which admin-dashboard records; publishes auth.dashboardUser.passwordSignInRestored when it unlinks any.

Index

Constructors

constructor

Methods

restorePasswordSignIn

Constructors

constructor

new DashboardSsoUserAdminService(
    __namedParameters: {
        audience: "bank" | "customer";
        cognito: CognitoAdminClient;
        db: B2bDatabase;
        internalEventPublisher: InternalEventPublisher;
    },
): DashboardSsoUserAdminService
Parameters
- __namedParameters: {
      audience: "bank" | "customer";
      cognito: CognitoAdminClient;
      db: B2bDatabase;
      internalEventPublisher: InternalEventPublisher;
  }
  - audience: "bank" | "customer"
  - cognito: CognitoAdminClient
    
    On the audience's own pool.
  - db: B2bDatabase
  - internalEventPublisher: InternalEventPublisher
Returns DashboardSsoUserAdminService
- Defined in packages/dashboard-auth-services/src/DashboardSsoUserAdminService.ts:51

Methods

restorePasswordSignIn

restorePasswordSignIn(
    __namedParameters: { userId: string },
): Promise<
    | { ok: true; value: SignInLinks }
    | {
        error:
            | ServiceError<
                | "DASHBOARD_USER_NOT_FOUND"
                | "COGNITO_USER_NOT_FOUND"
                | "SSO_DOMAIN_ACTIVE",
            >
            | ServiceError<"SSO_UNLINK_INCOMPLETE", SignInLinks>;
        ok: false;
    },
>
Unlinks every identity whose IdP is neither Google nor an ACTIVE connection's, then signs the user out everywhere, even after a partial unlink. Refused while their domain has ACTIVE SSO.
Parameters
- __namedParameters: { userId: string }
Returns Promise<
    | { ok: true; value: SignInLinks }
    | {
        error:
            | ServiceError<
                | "DASHBOARD_USER_NOT_FOUND"
                | "COGNITO_USER_NOT_FOUND"
                | "SSO_DOMAIN_ACTIVE",
            >
            | ServiceError<"SSO_UNLINK_INCOMPLETE", SignInLinks>;
        ok: false;
    },
>
- Defined in packages/dashboard-auth-services/src/DashboardSsoUserAdminService.ts:75

Class DashboardSsoUserAdminService

Index

Constructors

Methods

Constructors

constructor

Parameters

audience: "bank" | "customer"

cognito: CognitoAdminClient

db: B2bDatabase

internalEventPublisher: InternalEventPublisher

Returns DashboardSsoUserAdminService

Methods

restorePasswordSignIn

Parameters

Settings

On This Page

Class DashboardSsoUserAdminService

Index

Constructors

Methods

Constructors

constructor

Parameters

audience: "bank" | "customer"

cognito: CognitoAdminClient

db: B2bDatabase

internalEventPublisher: InternalEventPublisher

Returns DashboardSsoUserAdminService

Methods

restorePasswordSignIn

Parameters

Returns Promise< | { ok: true; value: SignInLinks } | { error: | ServiceError< | "DASHBOARD_USER_NOT_FOUND" | "COGNITO_USER_NOT_FOUND" | "SSO_DOMAIN_ACTIVE", > | ServiceError<"SSO_UNLINK_INCOMPLETE", SignInLinks>; ok: false; },>

Settings

On This Page

Returns Promise<
| { ok: true; value: SignInLinks }
| {
error:
| ServiceError<
| "DASHBOARD_USER_NOT_FOUND"
| "COGNITO_USER_NOT_FOUND"
| "SSO_DOMAIN_ACTIVE",
>
| ServiceError<"SSO_UNLINK_INCOMPLETE", SignInLinks>;
ok: false;
},
>