Navigation

Atlas Users

Note

Groups and projects are synonymous terms. Your {GROUP-ID} is the same as your project ID. For existing groups, your group/project ID remains the same. The resource and corresponding endpoints use the term groups.

The users resource allows you to create new Atlas users and assign them to any Atlas project for which you have the Project Owner role.

You can also modify your own Atlas profile. If you are the owner of an Atlas organization or project, you can also update the user roles for any user with membership in that organization or project.

Base URL: https://cloud.mongodb.com/api/atlas/v1.0

Endpoints

Method Endpoint Description
GET GET /groups/{GROUP-ID}/users Retrieves all Atlas users that belong to the project identified with the unique identifier {GROUP-ID}.
GET /users/{USER-ID} Retrieves the profile for the specified Atlas user identified with the unique identifier {USER-ID}.
GET /users/byName/{USER-NAME} Retrieves the profile for the specified Atlas user with username {USER-NAME}.
POST /users/ Creates a Atlas user and assigns it to one or more of your Atlas organizations or projects.
PATCH /users/{USER-ID} Updates the profile for the specified Atlas user identified with the unique identifier``{USER-ID}``.