Class ApiKeyApi

ApiKeyApi - object-oriented interface export ApiKeyApi

Hierarchy (view full)

BaseAPI
- ApiKeyApi

Index

Constructors

Properties

axios basePath configuration

Methods

apiKeyDelete apiKeyGet

Constructors

constructor

new ApiKeyApi(configuration?, basePath?, axios?): ApiKeyApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns ApiKeyApi
Inherited from BaseAPI.constructor
- Defined in src/api/base.ts:53

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

apiKeyDelete

apiKeyDelete(options?): Promise<AxiosResponse<void, any>>
summary Deletes the current API key for the current user.
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
memberof ApiKeyApi
- Defined in src/api/api.ts:11953

apiKeyGet

apiKeyGet(options?): Promise<AxiosResponse<void, any>>
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 Promise<AxiosResponse<void, any>>
Throws
memberof ApiKeyApi
- Defined in src/api/api.ts:11964