Class ApiKeyApi

ApiKeyApi - object-oriented interface

Export

ApiKeyApi

Hierarchy

BaseAPI
- ApiKeyApi

Index

Constructors

Properties

axios basePath configuration

Methods

createKey getKeys revokeKey

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 generated-client/base.ts:52

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

createKey

createKey(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: ApiKeyApiCreateKeyRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Create a new api key.

Throws
Memberof
ApiKeyApi
- Defined in generated-client/api/api-key-api.ts:274

getKeys

getKeys(options?): Promise<AxiosResponse<AuthenticationInfoQueryResult, any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<AuthenticationInfoQueryResult, any>>
Summary
Get all keys.

Throws
Memberof
ApiKeyApi
- Defined in generated-client/api/api-key-api.ts:285

revokeKey

revokeKey(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: ApiKeyApiRevokeKeyRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Remove an api key.

Throws
Memberof
ApiKeyApi
- Defined in generated-client/api/api-key-api.ts:297