Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TANSchemesApi

TANSchemesApi - object-oriented interface

export
class

TANSchemesApi

extends

{BaseAPI}

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Methods

getCurrentTanMedia

  • getCurrentTanMedia(accessId: string, options?: any): Promise<TanMedia>

  • Returns the currently selected TAN media for the access

    summary

    Get current TAN media

    throws

    {RequiredError}

    memberof

    TANSchemesApi

    Parameters

    • accessId: string

      The accessId for which to retrieve the current TAN media

    • Optional options: any

    Returns Promise<TanMedia>

getCurrentTanScheme

  • getCurrentTanScheme(accessId: string, options?: any): Promise<TanScheme>

  • Returns the currently selected TAN scheme for the access

    summary

    Get current TAN scheme.

    throws

    {RequiredError}

    memberof

    TANSchemesApi

    Parameters

    • accessId: string

      The accessId for which to retrieve the current TAN scheme

    • Optional options: any

    Returns Promise<TanScheme>

getTanSchemes

  • getTanSchemes(accessId: string, maxAge?: number, options?: any): Promise<TanScheme[]>

  • Retrieves all available TAN schemes for access

    summary

    List TAN schemes for access

    throws

    {RequiredError}

    memberof

    TANSchemesApi

    Parameters

    • accessId: string

      The id for the access for which to retrieve the TAN list

    • Optional maxAge: number
    • Optional options: any

    Returns Promise<TanScheme[]>

putCurrentTanMedia

  • putCurrentTanMedia(accessId: string, tanMediaId: string, options?: any): Promise<Access>

  • Update the access with a new currentTanMedia

    summary

    Update current TAN media

    throws

    {RequiredError}

    memberof

    TANSchemesApi

    Parameters

    • accessId: string

      The accessId for which to set the current TAN media

    • tanMediaId: string

      The id for the TAN media that should be set as the new currentTanMedia

    • Optional options: any

    Returns Promise<Access>

putCurrentTanScheme

  • putCurrentTanScheme(accessId: string, tanSchemeId: string, options?: any): Promise<Access>

  • Update the access with a new currentTanScheme

    summary

    Update current TAN scheme

    throws

    {RequiredError}

    memberof

    TANSchemesApi

    Parameters

    • accessId: string

      The accessId for which to set the current TAN scheme

    • tanSchemeId: string

      The id for the TAN scheme that should be set as the new currentTanScheme

    • Optional options: any

    Returns Promise<Access>