Function AdminApiFp

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

• adminCreateSession:function

  • adminCreateSession(options?): Promise<((axios?, basePath?) => AxiosPromise<AdminCreateSession201Response>)>

  • Parameters

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<AdminCreateSession201Response>)>

    Summary

    Obtain a session access token

    Throws

• adminDeleteSession:function

  • adminDeleteSession(options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>

  • Parameters

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<void>)>

    Summary

    Delete a session access token

    Throws

• adminLogin:function

  • adminLogin(provider, adminLoginRequest, options?): Promise<((axios?, basePath?) => 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: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<AdminLogin200Response>)>

    Summary

    Authenticate as an App Services administrator

    Throws

• getAdminAuthProviders:function

  • getAdminAuthProviders(options?): Promise<((axios?, basePath?) => AxiosPromise<any>)>

  • Parameters

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<any>)>

    Summary

    List App Services Admin Auth Providers

    Throws

• getAdminProfile:function

  • getAdminProfile(options?): Promise<((axios?, basePath?) => AxiosPromise<AdminUser>)>

  • Parameters

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<AdminUser>)>

    Summary

    Get information about the currently logged in user

    Throws