Interface AuthDefaultAdapterAPI

Interface for Auth's Default Adapter's API

Description

This interface is used to define the API for Auth's Default Adapter. Implement this interface to create a custom API for communicating with Auth functionality.

interface AuthDefaultAdapterAPI {
    checkToken(args, context?): Promise<Record<string, unknown>>;
    deleteRefreshTokensForUser(args, context?): Promise<void>;
    generateOnetimeToken(args, context?): Promise<TokenResponse>;
    invalidateToken(args, context?): Promise<TokenResponse>;
    restoreToken(args, context?): Promise<TokenResponse>;
}

Implemented by

Auth

checkToken deleteRefreshTokensForUser generateOnetimeToken invalidateToken restoreToken

Auth

checkToken

  • checkToken(args, context?): Promise<Record<string, unknown>>

  • API for checking token

    Parameters

    Returns Promise<Record<string, unknown>>

    Description

    This API is used to check token from Auth service to see if it is valid.

deleteRefreshTokensForUser

  • deleteRefreshTokensForUser(args, context?): Promise<void>

  • API for deleting refresh tokens for user

    Parameters

    • args: {
          userId: string;
      }

      User id to delete refresh tokens for.

      • userId: string
    • Optional context: RequestContext

    Returns Promise<void>

    Object containing the result of the operation.

    Description

    This API is used to delete refresh tokens for user from Auth service.

generateOnetimeToken

  • generateOnetimeToken(args, context?): Promise<TokenResponse>

  • API for generating onetime token

    Parameters

    Returns Promise<TokenResponse>

    Object containing the generated token.

    Description

    This API is used to generate onetime token from Auth service.

invalidateToken

  • invalidateToken(args, context?): Promise<TokenResponse>

  • API for invalidating onetime token

    Parameters

    Returns Promise<TokenResponse>

    Object containing the invalidated token.

    Description

    This API is used to invalidate onetime token from Auth service.

restoreToken

  • restoreToken(args, context?): Promise<TokenResponse>

  • API for restoring onetime token

    Parameters

    Returns Promise<TokenResponse>

    Object containing the restored token.

    Description

    This API is used to restore invalidated onetime token from Auth service.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc