Function AuthenticationApiFactory

Returns {
    authenticateUserByName(
        requestParameters: AuthenticationApiAuthenticateUserByNameRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<AuthenticationResult>;
    authenticateWithQuickConnect(
        requestParameters: AuthenticationApiAuthenticateWithQuickConnectRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<AuthenticationResult>;
    authorizeQuickConnect(
        requestParameters: AuthenticationApiAuthorizeQuickConnectRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<boolean>;
    createKey(
        requestParameters: AuthenticationApiCreateKeyRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    forgotPassword(
        requestParameters: AuthenticationApiForgotPasswordRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ForgotPasswordResult>;
    forgotPasswordPin(
        requestParameters: AuthenticationApiForgotPasswordPinRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<PinRedeemResult>;
    getAuthProviders(
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<NameIdPair[]>;
    getKeys(
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<AuthenticationInfoQueryResult>;
    getPasswordResetProviders(
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<NameIdPair[]>;
    getQuickConnectEnabled(
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<boolean>;
    getQuickConnectState(
        requestParameters: AuthenticationApiGetQuickConnectStateRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<QuickConnectResult>;
    initiateQuickConnect(
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<QuickConnectResult>;
    revokeKey(
        requestParameters: AuthenticationApiRevokeKeyRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
}

• authenticateUserByName: function

  • authenticateUserByName(
        requestParameters: AuthenticationApiAuthenticateUserByNameRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<AuthenticationResult>

    Parameters

    • requestParameters: AuthenticationApiAuthenticateUserByNameRequest

      Request parameters.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<AuthenticationResult>

    Throws

• authenticateWithQuickConnect: function

  • authenticateWithQuickConnect(
        requestParameters: AuthenticationApiAuthenticateWithQuickConnectRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<AuthenticationResult>

    Parameters

    • requestParameters: AuthenticationApiAuthenticateWithQuickConnectRequest

      Request parameters.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<AuthenticationResult>

    Throws

• authorizeQuickConnect: function

  • authorizeQuickConnect(
        requestParameters: AuthenticationApiAuthorizeQuickConnectRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<boolean>

    Parameters

    • requestParameters: AuthenticationApiAuthorizeQuickConnectRequest

      Request parameters.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<boolean>

    Throws

• createKey: function

  • createKey(
        requestParameters: AuthenticationApiCreateKeyRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

    Parameters

    • requestParameters: AuthenticationApiCreateKeyRequest

      Request parameters.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• forgotPassword: function

  • forgotPassword(
        requestParameters: AuthenticationApiForgotPasswordRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ForgotPasswordResult>

    Parameters

    • requestParameters: AuthenticationApiForgotPasswordRequest

      Request parameters.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<ForgotPasswordResult>

    Throws

• forgotPasswordPin: function

  • forgotPasswordPin(
        requestParameters: AuthenticationApiForgotPasswordPinRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<PinRedeemResult>

    Parameters

    • requestParameters: AuthenticationApiForgotPasswordPinRequest

      Request parameters.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<PinRedeemResult>

    Throws

• getAuthProviders: function

  • getAuthProviders(options?: RawAxiosRequestConfig): AxiosPromise<NameIdPair[]>

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<NameIdPair[]>

    Throws

• getKeys: function

  • getKeys(
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<AuthenticationInfoQueryResult>

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<AuthenticationInfoQueryResult>

    Throws

• getPasswordResetProviders: function

  • getPasswordResetProviders(
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<NameIdPair[]>

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<NameIdPair[]>

    Throws

• getQuickConnectEnabled: function

  • getQuickConnectEnabled(options?: RawAxiosRequestConfig): AxiosPromise<boolean>

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<boolean>

    Throws

• getQuickConnectState: function

  • getQuickConnectState(
        requestParameters: AuthenticationApiGetQuickConnectStateRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<QuickConnectResult>

    Parameters

    • requestParameters: AuthenticationApiGetQuickConnectStateRequest

      Request parameters.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<QuickConnectResult>

    Throws

• initiateQuickConnect: function

  • initiateQuickConnect(
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<QuickConnectResult>

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<QuickConnectResult>

    Throws

• revokeKey: function

  • revokeKey(
        requestParameters: AuthenticationApiRevokeKeyRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

    Parameters

    • requestParameters: AuthenticationApiRevokeKeyRequest

      Request parameters.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws