Function ApiKeyApiAxiosParamCreator

ApiKeyApi - axios parameter creator

Export

  • ApiKeyApiAxiosParamCreator(configuration?): {
        createKey: ((app: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getKeys: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        revokeKey: ((key: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

  • Parameters

    Returns {
        createKey: ((app: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getKeys: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        revokeKey: ((key: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

    • createKey: ((app: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Create a new api key.

      Throws

        • (app, options?): Promise<RequestArgs>

        • Parameters

          • app: string

            Name of the app using the authentication key.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getKeys: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Get all keys.

      Throws

        • (options?): Promise<RequestArgs>

        • Parameters

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • revokeKey: ((key: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Remove an api key.

      Throws

        • (key, options?): Promise<RequestArgs>

        • Parameters

          • key: string

            The access token to delete.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

Settings

Member Visibility