Get the Custom User Data Configuration | MongoDB Atlas App Services Admin API 3.0 documentation

Get the Custom User Data Configuration Obsoleto

OBTENER /groups/{groupId}/apps/{appId}/custom_user_data

Token auth

Get the Custom User Data configuration for an Atlas App Services App.

Parámetros de path

ID del grupo string Requerido

An Atlas Project/Group ID.
appId string Requerido

El ObjectID de tu aplicación. La sección de ID de Proyecto y ID de la aplicación de App Services API muestra cómo encontrar este valor.

Respuestas

200 aplicación/json

Ok
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- nombre_de_la_base_de_datos string
  
  El nombre de la base de datos que contiene datos de usuario personalizados.
- nombre_colección string
  
  The name of the collection that contains custom user data.
- user_id_field string
  
  El nombre de un campo que aparece en cada documento de datos de usuario personalizado y que contiene el ID de cuenta de usuario correspondiente a cada documento.
- habilitado booleano
  
  If true, custom user data is enabled.
- mongo_service_id string
  
  El valor _id de una fuente de datos MongoDB vinculada.
  
  You can list services with the Get all services endpoint.
  
  Data sources are services whose type is "mongodb-atlas". Use the _id value for the data source you want to link to the Trigger.
- on_user_creation_function_id string
  
  The _id value of a user creation function that runs whenever a new user registers.

GET /groups/{groupId}/apps/{appId}/custom_user_data

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

Ejemplos de respuestas (200)

{
  "database_name": "myapp",
  "collection_name": "users",
  "user_id_field": "user_account_id",
  "enabled": true,
  "mongo_service_id": "63c060ed32043ef4c93c2a9c",
  "on_user_creation_function_id": "63c055d8019a6ab879f661d6"
}