Interface AuthStrategyInterface<RoleType, UserType, AuthDataType, CredentialType, RequestPasswordResetDataType, ConfirmPasswordResetDataType, RefreshLoginDataType, LogoutData>

Interface for an auth strategy.

interface AuthStrategyInterface<
    RoleType extends string,
    UserType extends BaseUser<RoleType>,
    AuthDataType,
    CredentialType,
    RequestPasswordResetDataType,
    ConfirmPasswordResetDataType,
    RefreshLoginDataType,
    LogoutData,
> {
    belongsTo: <TargetEntity extends Newable<BaseEntity>>(
        request: HttpRequest | WebsocketRequest,
        targetEntity: TargetEntity,
        targetUserIdKey: keyof InstanceType<TargetEntity>,
        targetIdParamKey: string,
    ) => Promise<boolean>;
    confirmPasswordReset: (
        data: ConfirmPasswordResetDataType,
    ) => void | Promise<void>;
    hasRole: (
        request: HttpRequest | WebsocketRequest,
        allowedRoles: RoleType[],
    ) => Promise<boolean>;
    init: () => void;
    isLoggedIn: (request: HttpRequest | WebsocketRequest) => Promise<boolean>;
    login: (credentials: CredentialType) => Promise<AuthDataType>;
    logout: (data: LogoutData) => Promise<void>;
    name: string;
    refreshLogin: (data: RefreshLoginDataType) => Promise<AuthDataType>;
    requestPasswordReset: (
        data: RequestPasswordResetDataType,
    ) => void | Promise<void>;
    resolveUser: (
        request: HttpRequest | WebsocketRequest,
    ) => Promise<undefined | UserType>;
    securityScheme: SecuritySchemeObject;
}

Type Parameters

  • RoleType extends string
  • UserType extends BaseUser<RoleType>
  • AuthDataType
  • CredentialType
  • RequestPasswordResetDataType
  • ConfirmPasswordResetDataType
  • RefreshLoginDataType
  • LogoutData

Implemented by

Properties

belongsTo confirmPasswordReset hasRole init isLoggedIn login logout name refreshLogin requestPasswordReset resolveUser securityScheme

Properties

belongsTo

belongsTo: <TargetEntity extends Newable<BaseEntity>>(
    request: HttpRequest | WebsocketRequest,
    targetEntity: TargetEntity,
    targetUserIdKey: keyof InstanceType<TargetEntity>,
    targetIdParamKey: string,
) => Promise<boolean>

Checks whether a currently logged belongs to the requested resource.

confirmPasswordReset

confirmPasswordReset: (
    data: ConfirmPasswordResetDataType,
) => void | Promise<void>

Confirms a new password for a user using the provided confirm password reset data.

hasRole

hasRole: (
    request: HttpRequest | WebsocketRequest,
    allowedRoles: RoleType[],
) => Promise<boolean>

Checks whether a currently logged in user has one of the provided roles.

init

init: () => void

Initializes the strategy.

isLoggedIn

isLoggedIn: (request: HttpRequest | WebsocketRequest) => Promise<boolean>

Checks whether a user is currently logged in.

login

login: (credentials: CredentialType) => Promise<AuthDataType>

Logs in a user.

logout

logout: (data: LogoutData) => Promise<void>

Logs out the current user.

name

name: string

The name of the auth strategy.

refreshLogin

refreshLogin: (data: RefreshLoginDataType) => Promise<AuthDataType>

Refreshes the login of a user.

requestPasswordReset

requestPasswordReset: (
    data: RequestPasswordResetDataType,
) => void | Promise<void>

Request a new password for a user using the request password reset data.

resolveUser

resolveUser: (
    request: HttpRequest | WebsocketRequest,
) => Promise<undefined | UserType>

Resolves the current user.

securityScheme

securityScheme: SecuritySchemeObject

The security scheme object to be used by open api.

Settings

Member Visibility

On This Page

Properties