Function ApiKeyApiFactory

ApiKeyApi - factory interface export

  • ApiKeyApiFactory(configuration?, basePath?, axios?): {
        apiKeyDelete(options?: RawAxiosRequestConfig): AxiosPromise<OkObjectResult>;
        apiKeyGet(options?: RawAxiosRequestConfig): AxiosPromise<ApiKey>;
    }

  • Parameters

    • Optionalconfiguration: Configuration
    • OptionalbasePath: string
    • Optionalaxios: AxiosInstance

    Returns {
        apiKeyDelete(options?: RawAxiosRequestConfig): AxiosPromise<OkObjectResult>;
        apiKeyGet(options?: RawAxiosRequestConfig): AxiosPromise<ApiKey>;
    }

    • apiKeyDelete:function
      • apiKeyDelete(options?): AxiosPromise<OkObjectResult>

      • summary Deletes the current API key for the current user.

        Parameters

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<OkObjectResult>

        Throws

    • apiKeyGet:function
      • apiKeyGet(options?): AxiosPromise<ApiKey>

      • The user's account must have Jammber.RainCloud.ApiKey.Create. permissions summary Retrieves the user's current API Keys if they already exist, otherwise a new ClientID and ClientSecret will be generated for the user's account.

        Parameters

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<ApiKey>

        Throws

Settings

Member Visibility