获取自定义用户数据配置 已弃用

获取 /groups/{groupId}/apps/{appId}/custom_user_data
tokenAuth

获取 Atlas App Services App 的自定义用户数据配置。

路径参数

响应

  • 200 application/json

    Ok

    隐藏响应属性 显示响应属性 对象
    • database_name 字符串

      包含自定义用户数据的数据库名称。

    • collection_name 字符串

      包含自定义用户数据的集合名称。

    • user_id_field 字符串

      每个自定义用户数据文档中显示的字段名称，其中包含每个文档相应用户的用户帐户 ID。

    • enabled 布尔

      如果为 true，则启用自定义用户数据。

    • mongo_service_id 字符串

      链接的MongoDB数据源的_id值。

      您可以使用“获取所有服务”端点列出服务。

      数据源是 type 为“mongodb-atlas”的服务。使用要链接到触发的数据源的 _id 值。

    • on_user_creation_function_id 字符串

      用户创建函数的 _id 值，该函数在新用户注册时运行。
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"
响应示例 (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"
}