Function UsersApiFactory

Returns {
    adminCreateUser(groupId, appId, adminCreateUserRequest, options?) => AxiosPromise<User>;
    adminDeletePendingEmailPasswordUser(groupId, appId, email, options?) => AxiosPromise<void>;
    adminDeleteUser(groupId, appId, userId, options?) => AxiosPromise<void>;
    adminDisableUser(groupId, appId, userId, options?) => AxiosPromise<void>;
    adminEnableUser(groupId, appId, userId, options?) => AxiosPromise<void>;
    adminGetUser(groupId, appId, userId, options?) => AxiosPromise<User>;
    adminListDevices(groupId, appId, userId, options?) => AxiosPromise<any>;
    adminListPendingUsers(groupId, appId, after?, options?) => AxiosPromise<any>;
    adminListUsers(after?, sort?, desc?, options?) => AxiosPromise<any>;
    adminResetUserEmail(groupId, appId, userId, adminResetUserEmailRequest, options?) => AxiosPromise<void>;
    adminUserLogout(groupId, appId, userId, options?) => AxiosPromise<void>;
    adminVerifyUserAccessToken(groupId, appId, adminVerifyUserAccessTokenRequest, options?) => AxiosPromise<any>;
}

• adminCreateUser:function

  • adminCreateUser(groupId, appId, adminCreateUserRequest, options?): AxiosPromise<User>

  • Create a new email/password user account. Note: You cannot create user accounts through the Admin API for any authentication provider other than email/password.

    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.

    • adminCreateUserRequest: AdminCreateUserRequest

      The user to create

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<User>

    Summary

    Create a user

    Throws

• adminDeletePendingEmailPasswordUser:function

  • adminDeletePendingEmailPasswordUser(groupId, appId, email, options?): AxiosPromise<void>

  • Delete a pending user.

    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.

    • email: any

      Email address

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Delete a pending email/password authentication user

    Throws

• adminDeleteUser:function

  • adminDeleteUser(groupId, appId, userId, options?): AxiosPromise<void>

  • Delete a specific user account by ID.

    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.

    • userId: any

      User Account ID

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Delete a user

    Throws

• adminDisableUser:function

  • adminDisableUser(groupId, appId, userId, options?): AxiosPromise<void>

  • Disable a user.

    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.

    • userId: any

      User Account ID

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Disable a user

    Throws

• adminEnableUser:function

  • adminEnableUser(groupId, appId, userId, options?): AxiosPromise<void>

  • Enable a user.

    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.

    • userId: any

      User Account ID

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Enable a user

    Throws

• adminGetUser:function

  • adminGetUser(groupId, appId, userId, options?): AxiosPromise<User>

  • Get a specific user account by ID.

    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.

    • userId: any

      User Account ID

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<User>

    Summary

    Get a User

    Throws

• adminListDevices:function

  • adminListDevices(groupId, appId, userId, options?): AxiosPromise<any>

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

    • userId: any

      User Account ID

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<any>

    Summary

    List a user's devices

    Throws

• adminListPendingUsers:function

  • adminListPendingUsers(groupId, appId, after?, options?): AxiosPromise<any>

  • List pending user account registrations. Returns up to 50 pending users in a call.

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

      The unique ``_id`` for a pending user. ``List pending users`` can return 50 pending users at a time. To view additional results, find the ``_id`` of the last pending user listed in the previous call to ``list pending users``. Call ``list pending users`` again, passing the ``_id`` to the after parameter.

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<any>

    Summary

    List pending users

    Throws

• adminListUsers:function

  • adminListUsers(after?, sort?, desc?, options?): AxiosPromise<any>

  • List confirmed user accounts.

    Parameters

    • Optional after: any

      The `id` of the last user returned by a previous paginated request.

    • Optional sort: any

      The field name to sort results by. The only valid value is the default: `_id`.

    • Optional desc: any

      If `true`, returns sorted results in descending order. If not specified or set to `false`, results return in ascending order.

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<any>

    Summary

    List users

    Throws

• adminResetUserEmail:function

  • adminResetUserEmail(groupId, appId, userId, adminResetUserEmailRequest, options?): AxiosPromise<void>

  • Change the email address for an email/password user by ID.

    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.

    • userId: any

      User Account ID

    • adminResetUserEmailRequest: AdminResetUserEmailRequest

      The new email address for the user.

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Change a user's email

    Throws

• adminUserLogout:function

  • adminUserLogout(groupId, appId, userId, options?): AxiosPromise<void>

  • Revoke all of a user's sessions.

    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.

    • userId: any

      User Account ID

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Revoke user sessions

    Throws

• adminVerifyUserAccessToken:function

  • adminVerifyUserAccessToken(groupId, appId, adminVerifyUserAccessTokenRequest, options?): AxiosPromise<any>

  • Verify a that a user's client access token is valid.

    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.

    • adminVerifyUserAccessTokenRequest: AdminVerifyUserAccessTokenRequest

      The user&#39;s client access token. The access token represents a logged in application user. This is not the same as the ``access_token`` that you use to work with the Admin API.

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<any>

    Summary

    Verify & decode an access token

    Throws