Function AdminApiFactory

Returns {
    adminCreateSession(options?) => AxiosPromise<AdminCreateSession201Response>;
    adminDeleteSession(options?) => AxiosPromise<void>;
    adminLogin(provider, adminLoginRequest, options?) => AxiosPromise<AdminLogin200Response>;
    getAdminAuthProviders(options?) => AxiosPromise<any>;
    getAdminProfile(options?) => AxiosPromise<AdminUser>;
}

• adminCreateSession:function

  • adminCreateSession(options?): AxiosPromise<AdminCreateSession201Response>

  • Parameters

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<AdminCreateSession201Response>

    Summary

    Obtain a session access token

    Throws

• adminDeleteSession:function

  • adminDeleteSession(options?): AxiosPromise<void>

  • Parameters

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Delete a session access token

    Throws

• adminLogin:function

  • adminLogin(provider, adminLoginRequest, options?): AxiosPromise<AdminLogin200Response>

  • 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: any

      Override http request option.

    Returns AxiosPromise<AdminLogin200Response>

    Summary

    Authenticate as an App Services administrator

    Throws

• getAdminAuthProviders:function

  • getAdminAuthProviders(options?): AxiosPromise<any>

  • Parameters

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<any>

    Summary

    List App Services Admin Auth Providers

    Throws

• getAdminProfile:function

  • getAdminProfile(options?): AxiosPromise<AdminUser>

  • Parameters

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<AdminUser>

    Summary

    Get information about the currently logged in user

    Throws