Function QuickConnectApiFp

Returns {
    authorizeQuickConnect(code: string, userId?: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>)>;
    getQuickConnectEnabled(options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>)>;
    getQuickConnectState(secret: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuickConnectResult>)>;
    initiateQuickConnect(options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuickConnectResult>)>;
}

• authorizeQuickConnect:function

  • authorizeQuickConnect(code, userId?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>)>

  • Parameters

    • code: string

      Quick connect code to authorize.
    • OptionaluserId: string

      The user the authorize. Access to the requested user is required.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>)>

    Summary

    Authorizes a pending quick connect request.

    Throws

• getQuickConnectEnabled:function

  • getQuickConnectEnabled(options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>)>

  • Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>)>

    Summary

    Gets the current quick connect state.

    Throws

• getQuickConnectState:function

  • getQuickConnectState(secret, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuickConnectResult>)>

  • Parameters

    • secret: string

      Secret previously returned from the Initiate endpoint.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuickConnectResult>)>

    Summary

    Attempts to retrieve authentication information.

    Throws

• initiateQuickConnect:function

  • initiateQuickConnect(options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuickConnectResult>)>

  • Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuickConnectResult>)>

    Summary

    Initiate a new quick connect request.

    Throws