List pending users

GET /groups/{groupId}/apps/{appId}/user_registrations/pending_users

Token auth

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

Path parameters

groupId string Required

An Atlas Project/Group ID.
appId string Required

The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

Query parameters

after string

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.

Responses

200 application/json

Success
Hide response attributes Show response attributes object
- _id string Required
  
  The unique pending user account ID
- user_id string
- domain_id string Required
- login_ids array[object] Required
  
  A list of identities associated with the pending user
  
  Hide login_ids attributes Show login_ids attributes object
  
  id_type string Required
  
  Value is email.
  
  id string Required
  
  The pending user's username. For example, this is an email/password user's email address.

GET /groups/{groupId}/apps/{appId}/user_registrations/pending_users

curl \
 --request GET 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/user_registrations/pending_users' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

[
  {
    "_id": "63754f968a605a78ea6939e7",
    "user_id": "",
    "domain_id": "60c8f69864c0a72d14bb534c",
    "login_ids": [
      {
        "id": "someone@example.com",
        "id_type": "email"
      }
    ]
  },
  {
    "_id": "63754fd83c001970b1e5ea66",
    "user_id": "",
    "domain_id": "60c8f69864c0a73e3e11c22b",
    "login_ids": [
      {
        "id": "joe@example.com",
        "id_type": "email"
      }
    ]
  }
]