Class ClientAccessKeysApi

ClientAccessKeysApi - object-oriented interface

export

Hierarchy

BaseAPI
- ClientAccessKeysApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ClientAccessKeysApi(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): ClientAccessKeysApi

Inherited from BaseAPI.constructor
- Defined in api/base.ts:50
Parameters
- Optional configuration: Configuration
- basePath: string = ...
- axios: AxiosInstance = ...
Returns ClientAccessKeysApi

Properties

Protected axios

axios: AxiosInstance = ...

Protected basePath

basePath: string = ...

Protected configuration

configuration: undefined | Configuration

Methods

addClientAccessKey

addClientAccessKey(requestParameters: ClientAccessKeysApiAddClientAccessKeyRequest, options?: any): Promise<AxiosResponse<ClientAccessKeysResponse>>

- Defined in api/api.ts:5363
Create a client access key

summary

add_client_access_key

throws

{RequiredError}

memberof

ClientAccessKeysApi

Parameters
- requestParameters: ClientAccessKeysApiAddClientAccessKeyRequest
  
  Request parameters.
- Optional options: any
Returns Promise<AxiosResponse<ClientAccessKeysResponse>>

deleteClientAccessKey

deleteClientAccessKey(requestParameters: ClientAccessKeysApiDeleteClientAccessKeyRequest, options?: any): Promise<AxiosResponse<void>>

- Defined in api/api.ts:5375
Delete a client access key, specified by id.

summary

delete_client_access_key

throws

{RequiredError}

memberof

ClientAccessKeysApi

Parameters
- requestParameters: ClientAccessKeysApiDeleteClientAccessKeyRequest
  
  Request parameters.
- Optional options: any
Returns Promise<AxiosResponse<void>>

getClientAccessKeyById

getClientAccessKeyById(requestParameters: ClientAccessKeysApiGetClientAccessKeyByIdRequest, options?: any): Promise<AxiosResponse<ClientAccessKeysResponse>>

- Defined in api/api.ts:5387
Get information about specific client access key, specified by id.

summary

get_client_access_key_by_id

throws

{RequiredError}

memberof

ClientAccessKeysApi

Parameters
- requestParameters: ClientAccessKeysApiGetClientAccessKeyByIdRequest
  
  Request parameters.
- Optional options: any
Returns Promise<AxiosResponse<ClientAccessKeysResponse>>

getClientAccessKeys

getClientAccessKeys(requestParameters?: ClientAccessKeysApiGetClientAccessKeysRequest, options?: any): Promise<AxiosResponse<ClientAccessKeysResponse[]>>

- Defined in api/api.ts:5399
Get a listing of client access keys for your organization.

summary

get_client_access_keys

throws

{RequiredError}

memberof

ClientAccessKeysApi

Parameters
- requestParameters: ClientAccessKeysApiGetClientAccessKeysRequest = {}
  
  Request parameters.
- Optional options: any
Returns Promise<AxiosResponse<ClientAccessKeysResponse[]>>

updatetheNameofaClientAccessKey

updatetheNameofaClientAccessKey(requestParameters: ClientAccessKeysApiUpdatetheNameofaClientAccessKeyRequest, options?: any): Promise<AxiosResponse<void>>

- Defined in api/api.ts:5411
Update the name of a client access key.

summary

Update the Name of a Client Access Key

throws

{RequiredError}

memberof

ClientAccessKeysApi

Parameters
- requestParameters: ClientAccessKeysApiUpdatetheNameofaClientAccessKeyRequest
  
  Request parameters.
- Optional options: any
Returns Promise<AxiosResponse<void>>