Function AdminApiAxiosParamCreator

Returns {
    adminCreateSession: ((options?) => Promise<RequestArgs>);
    adminDeleteSession: ((options?) => Promise<RequestArgs>);
    adminLogin: ((provider, adminLoginRequest, options?) => Promise<RequestArgs>);
    getAdminAuthProviders: ((options?) => Promise<RequestArgs>);
    getAdminProfile: ((options?) => Promise<RequestArgs>);
}

• adminCreateSession: ((options?) => Promise<RequestArgs>)

  • • (options?): Promise<RequestArgs>

    • Parameters

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Obtain a session access token

      Throws

• adminDeleteSession: ((options?) => Promise<RequestArgs>)

  • • (options?): Promise<RequestArgs>

    • Parameters

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Delete a session access token

      Throws

• adminLogin: ((provider, adminLoginRequest, options?) => Promise<RequestArgs>)

  • • (provider, adminLoginRequest, options?): Promise<RequestArgs>

    • 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<RequestArgs>

      Summary

      Authenticate as an App Services administrator

      Throws

• getAdminAuthProviders: ((options?) => Promise<RequestArgs>)

  • • (options?): Promise<RequestArgs>

    • Parameters

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      List App Services Admin Auth Providers

      Throws

• getAdminProfile: ((options?) => Promise<RequestArgs>)

  • • (options?): Promise<RequestArgs>

    • Parameters

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Get information about the currently logged in user

      Throws