Class ApikeysApi

ApikeysApi - object-oriented interface

Export

Hierarchy

BaseAPI
- ApikeysApi

Implements

ApikeysApiInterface

Index

Constructors

constructor

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

Properties

`Protected` axios

axios: AxiosInstance = globalAxios

`Protected` basePath

basePath: string = BASE_PATH

`Protected` configuration

configuration: Configuration

Methods

adminCreateApiKey

adminCreateApiKey(groupId, appId, adminCreateApiKeyRequest, options?): Promise<AxiosResponse<ApiKey, any>>
Create a new API key.
Parameters
- groupId: any
  
  An Atlas Project/Group ID.
- appId: any
  
  The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.
- adminCreateApiKeyRequest: AdminCreateApiKeyRequest
  
  The API key to create.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<ApiKey, any>>

Summary
Create a new API key

Throws

Memberof
ApikeysApi
Implementation of ApikeysApiInterface.adminCreateApiKey
- Defined in src/api.ts:4846

adminDeleteApiKey

adminDeleteApiKey(groupId, appId, apiKeyId, options?): Promise<AxiosResponse<void, any>>
Delete an API key.
Parameters
- groupId: any
  
  An Atlas Project/Group ID.
- appId: any
  
  The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.
- apiKeyId: any
  
  The unique `_id` value of an API key
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<void, any>>

Summary
Delete an API key

Throws

Memberof
ApikeysApi
Implementation of ApikeysApiInterface.adminDeleteApiKey
- Defined in src/api.ts:4860

adminDisableApiKey

adminDisableApiKey(groupId, appId, apiKeyId, options?): Promise<AxiosResponse<void, any>>
Disable an API key.
Parameters
- groupId: any
  
  An Atlas Project/Group ID.
- appId: any
  
  The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.
- apiKeyId: any
  
  The unique `_id` value of an API key
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<void, any>>

Summary
Disable an API key

Throws

Memberof
ApikeysApi
Implementation of ApikeysApiInterface.adminDisableApiKey
- Defined in src/api.ts:4874

adminEnableApiKey

adminEnableApiKey(groupId, appId, apiKeyId, options?): Promise<AxiosResponse<void, any>>
Enable an API key.
Parameters
- groupId: any
  
  An Atlas Project/Group ID.
- appId: any
  
  The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.
- apiKeyId: any
  
  The unique `_id` value of an API key
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<void, any>>

Summary
Enable an API key

Throws

Memberof
ApikeysApi
Implementation of ApikeysApiInterface.adminEnableApiKey
- Defined in src/api.ts:4888

adminGetApiKey

adminGetApiKey(groupId, appId, apiKeyId, options?): Promise<AxiosResponse<ApiKeyResponse, any>>
Retrieve information about an API key.
Parameters
- groupId: any
  
  An Atlas Project/Group ID.
- appId: any
  
  The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.
- apiKeyId: any
  
  The unique `_id` value of an API key
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<ApiKeyResponse, any>>

Summary
Retrieve information about an API key

Throws

Memberof
ApikeysApi
Implementation of ApikeysApiInterface.adminGetApiKey
- Defined in src/api.ts:4902

adminListApiKeys

adminListApiKeys(groupId, appId, options?): Promise<AxiosResponse<any, any>>
List API keys associated with a Atlas App Services App.
Parameters
- groupId: any
  
  An Atlas Project/Group ID.
- appId: any
  
  The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<any, any>>

Summary
List API keys

Throws

Memberof
ApikeysApi
Implementation of ApikeysApiInterface.adminListApiKeys
- Defined in src/api.ts:4915

Class ApikeysApi

Export

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional configuration: Configuration

basePath: string = BASE_PATH

axios: AxiosInstance = globalAxios

Returns ApikeysApi

Properties

Protected axios

Protected basePath

Protected configuration

Methods

adminCreateApiKey

Parameters

groupId: any

appId: any

adminCreateApiKeyRequest: AdminCreateApiKeyRequest

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<ApiKey, any>>

Summary

Throws

Memberof

adminDeleteApiKey

Parameters

groupId: any

appId: any

apiKeyId: any

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<void, any>>

Summary

Throws

Memberof

adminDisableApiKey

Parameters

groupId: any

appId: any

apiKeyId: any

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<void, any>>

Summary

Throws

Memberof

adminEnableApiKey

Parameters

groupId: any

appId: any

apiKeyId: any

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<void, any>>

Summary

Throws

Memberof

adminGetApiKey

Parameters

groupId: any

appId: any

apiKeyId: any

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<ApiKeyResponse, any>>

Summary

Throws

Memberof

adminListApiKeys

Parameters

groupId: any

appId: any

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<any, any>>

Summary

Throws

Memberof

Settings

`Optional` configuration: Configuration

`Protected` axios

`Protected` basePath

`Protected` configuration

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>