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.
An Atlas Project/Group ID.
The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.
The user to create
Optional options: AxiosRequestConfig<any>Override http request option.
Create a user
UsersApiInterface
Delete a pending user.
An Atlas Project/Group ID.
The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.
Email address
Optional options: AxiosRequestConfig<any>Override http request option.
Delete a pending email/password authentication user
UsersApiInterface
Delete a specific user account by ID.
An Atlas Project/Group ID.
The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.
User Account ID
Optional options: AxiosRequestConfig<any>Override http request option.
Delete a user
UsersApiInterface
Disable a user.
An Atlas Project/Group ID.
The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.
User Account ID
Optional options: AxiosRequestConfig<any>Override http request option.
Disable a user
UsersApiInterface
Enable a user.
An Atlas Project/Group ID.
The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.
User Account ID
Optional options: AxiosRequestConfig<any>Override http request option.
Enable a user
UsersApiInterface
Get a specific user account by ID.
An Atlas Project/Group ID.
The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.
User Account ID
Optional options: AxiosRequestConfig<any>Override http request option.
Get a User
UsersApiInterface
An Atlas Project/Group ID.
The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.
User Account ID
Optional options: AxiosRequestConfig<any>Override http request option.
List a user's devices
UsersApiInterface
List pending user account registrations. Returns up to 50 pending users in a call.
An Atlas Project/Group ID.
The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.
Optional after: anyThe 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.
List pending users
UsersApiInterface
List confirmed user accounts.
Optional after: anyThe `id` of the last user returned by a previous paginated request.
Optional sort: anyThe field name to sort results by. The only valid value is the default: `_id`.
Optional desc: anyIf `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.
List users
UsersApiInterface
Change the email address for an email/password user by ID.
An Atlas Project/Group ID.
The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.
User Account ID
The new email address for the user.
Optional options: AxiosRequestConfig<any>Override http request option.
Change a user's email
UsersApiInterface
Revoke all of a user's sessions.
An Atlas Project/Group ID.
The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.
User Account ID
Optional options: AxiosRequestConfig<any>Override http request option.
Revoke user sessions
UsersApiInterface
Verify a that a user's client access token is valid.
An Atlas Project/Group ID.
The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.
The user'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.
Verify & decode an access token
UsersApiInterface
Generated using TypeDoc
UsersApi - interface
Export
UsersApi