Function ApiKeyApiFp

Returns {
    createKey(app: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
    getKeys(options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationInfoQueryResult>)>;
    revokeKey(key: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
}

• createKey:function

  • createKey(app, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

  • Parameters

    • app: string

      Name of the app using the authentication key.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Summary

    Create a new api key.

    Throws

• getKeys:function

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

  • Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Summary

    Get all keys.

    Throws

• revokeKey:function

  • revokeKey(key, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

  • Parameters

    • key: string

      The access token to delete.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Summary

    Remove an api key.

    Throws