Class AuthDefaultAdapterRestSdk

Default Adapter for Auth

Description

This class is used to define the default adapter for Auth. This adapter uses the REST SDK to communicate with Auth functionality.

Implements

Constructors

constructor

Properties

authServiceEndpoint checkTokenPath deleteRefreshTokensForUserPath generateOnetimeTokenPath internalToken invalidateTokenPath restoreTokenPath DEFAULT_CHECK_TOKEN_PATH DEFAULT_DELETE_REFRESH_TOKENS_FOR_USER_PATH DEFAULT_GENERATE_ONETIME_TOKEN_PATH DEFAULT_INVALIDATE_TOKEN_PATH DEFAULT_RESTORE_TOKEN_PATH

Auth

checkToken deleteRefreshTokensForUser generateOnetimeToken invalidateToken restoreToken

Constructors

constructor

Properties

Private authServiceEndpoint

authServiceEndpoint: string

Private checkTokenPath

checkTokenPath: string

Private deleteRefreshTokensForUserPath

deleteRefreshTokensForUserPath: string

Private generateOnetimeTokenPath

generateOnetimeTokenPath: string

Private internalToken

internalToken: string

Private invalidateTokenPath

invalidateTokenPath: string

Private restoreTokenPath

restoreTokenPath: string

Static Private Readonly DEFAULT_CHECK_TOKEN_PATH

DEFAULT_CHECK_TOKEN_PATH: "/check-token" = '/check-token'

Static Private Readonly DEFAULT_DELETE_REFRESH_TOKENS_FOR_USER_PATH

DEFAULT_DELETE_REFRESH_TOKENS_FOR_USER_PATH: "/users/:userId/refreshTokens" = '/users/:userId/refreshTokens'

Static Private Readonly DEFAULT_GENERATE_ONETIME_TOKEN_PATH

DEFAULT_GENERATE_ONETIME_TOKEN_PATH: "/generate-onetime-token" = '/generate-onetime-token'

Static Private Readonly DEFAULT_INVALIDATE_TOKEN_PATH

DEFAULT_INVALIDATE_TOKEN_PATH: "/invalidate-onetime-token" = '/invalidate-onetime-token'

Static Private Readonly DEFAULT_RESTORE_TOKEN_PATH

DEFAULT_RESTORE_TOKEN_PATH: "/restore-onetime-token" = '/restore-onetime-token'

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

invalidateToken

restoreToken

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc