users

Create a 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.

post/groups/{groupId}/apps/{appId}/users

Request

  • Base URL
    https://services.cloud.mongodb.com/api/admin/v3.0
  • URL
    https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/users
  • Auth
    HTTP bearer

Request body

emailstring required
passwordstring required

Response

Successfully created.

_idstring

The unique user account ID

type'normal' | 'server'

The user type. Most users are normal and represent a specific human user. Users created through the api-key provider have the type server because they are typically used for programmatic access from a server.

creation_dateinteger

The date and time that the user account was created. Represented by the number of seconds since the UNIX epoch.

last_authentication_dateinteger

The date and time that the user account last logged in or authenticated a request. Represented by the number of seconds since the UNIX epoch.

disabledboolean

If true, the user account is inactive and cannot login or interact with App Services.

dataobject

Metadata that describes the user. This field combines the data for all authentication identities associated with the user. The exact field names and values depend on which authentication providers the user has authenticated with.

For example, if a user has linked an email/password account with their Google account, this object might contain their email as well as metadata fields from Google like name and picture.

Changes

No recorded changes to this operation across all 50 revisions of this API.