Class AdminApi

AdminApi - object-oriented interface

Export

Hierarchy

BaseAPI
- AdminApi

Implements

AdminApiInterface

Index

Constructors

Properties

axios basePath configuration

Methods

adminCreateSession adminDeleteSession adminLogin getAdminAuthProviders getAdminProfile

Constructors

constructor

new AdminApi(configuration?, basePath?, axios?): AdminApi
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns AdminApi
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

adminCreateSession

adminCreateSession(options?): Promise<AxiosResponse<AdminCreateSession201Response, any>>
Parameters
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<AdminCreateSession201Response, any>>

Summary
Obtain a session access token

Throws

Memberof
AdminApi
Implementation of AdminApiInterface.adminCreateSession
- Defined in src/api.ts:4246

adminDeleteSession

adminDeleteSession(options?): Promise<AxiosResponse<void, any>>
Parameters
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<void, any>>

Summary
Delete a session access token

Throws

Memberof
AdminApi
Implementation of AdminApiInterface.adminDeleteSession
- Defined in src/api.ts:4257

adminLogin

adminLogin(provider, adminLoginRequest, options?): Promise<AxiosResponse<AdminLogin200Response, any>>
Authenticate as an App Services administrator using an Atlas programmatic API key pair. To learn more, see Get An Admin API Session Access Token.
Parameters
- provider: ProviderType
  
  The authentication provider to use.
- adminLoginRequest: AdminLoginRequest
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<AdminLogin200Response, any>>

Summary
Authenticate as an App Services administrator

Throws

Memberof
AdminApi
Implementation of AdminApiInterface.adminLogin
- Defined in src/api.ts:4270

getAdminAuthProviders

getAdminAuthProviders(options?): Promise<AxiosResponse<any, any>>
Parameters
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<any, any>>

Summary
List App Services Admin Auth Providers

Throws

Memberof
AdminApi
Implementation of AdminApiInterface.getAdminAuthProviders
- Defined in src/api.ts:4281

getAdminProfile

getAdminProfile(options?): Promise<AxiosResponse<AdminUser, any>>
Parameters
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<AdminUser, any>>

Summary
Get information about the currently logged in user

Throws

Memberof
AdminApi
Implementation of AdminApiInterface.getAdminProfile
- Defined in src/api.ts:4292

Generated using TypeDoc