Function UsersApiAxiosParamCreator

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

• adminCreateUser: ((groupId, appId, adminCreateUserRequest, options?) => Promise<RequestArgs>)

  • • (groupId, appId, adminCreateUserRequest, options?): Promise<RequestArgs>

    • 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: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Create a user

      Throws

• adminDeletePendingEmailPasswordUser: ((groupId, appId, email, options?) => Promise<RequestArgs>)

  • • (groupId, appId, email, options?): Promise<RequestArgs>

    • 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: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Delete a pending email/password authentication user

      Throws

• adminDeleteUser: ((groupId, appId, userId, options?) => Promise<RequestArgs>)

  • • (groupId, appId, userId, options?): Promise<RequestArgs>

    • 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: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Delete a user

      Throws

• adminDisableUser: ((groupId, appId, userId, options?) => Promise<RequestArgs>)

  • • (groupId, appId, userId, options?): Promise<RequestArgs>

    • 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: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Disable a user

      Throws

• adminEnableUser: ((groupId, appId, userId, options?) => Promise<RequestArgs>)

  • • (groupId, appId, userId, options?): Promise<RequestArgs>

    • 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: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Enable a user

      Throws

• adminGetUser: ((groupId, appId, userId, options?) => Promise<RequestArgs>)

  • • (groupId, appId, userId, options?): Promise<RequestArgs>

    • 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: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Get a User

      Throws

• adminListDevices: ((groupId, appId, userId, options?) => Promise<RequestArgs>)

  • • (groupId, appId, userId, options?): Promise<RequestArgs>

    • 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: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      List a user's devices

      Throws

• adminListPendingUsers: ((groupId, appId, after?, options?) => Promise<RequestArgs>)

  • • (groupId, appId, after?, options?): Promise<RequestArgs>

    • 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: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      List pending users

      Throws

• adminListUsers: ((after?, sort?, desc?, options?) => Promise<RequestArgs>)

  • • (after?, sort?, desc?, options?): Promise<RequestArgs>

    • 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: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      List users

      Throws

• adminResetUserEmail: ((groupId, appId, userId, adminResetUserEmailRequest, options?) => Promise<RequestArgs>)

  • • (groupId, appId, userId, adminResetUserEmailRequest, options?): Promise<RequestArgs>

    • 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: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Change a user's email

      Throws

• adminUserLogout: ((groupId, appId, userId, options?) => Promise<RequestArgs>)

  • • (groupId, appId, userId, options?): Promise<RequestArgs>

    • 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: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Revoke user sessions

      Throws

• adminVerifyUserAccessToken: ((groupId, appId, adminVerifyUserAccessTokenRequest, options?) => Promise<RequestArgs>)

  • • (groupId, appId, adminVerifyUserAccessTokenRequest, options?): Promise<RequestArgs>

    • 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: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Verify & decode an access token

      Throws