Configurar dados de usuário personalizados Obsoleto(a)

REMENDO /groups/{groupId}/apps/{appId}/custom_user_data
tokenAuth

Modifique a configuração de dados personalizados do usuário para um aplicativo do Atlas App Services.

parâmetros de caminho

aplicação/json

corpo, corpo

  • nome do banco de dados string

    O nome do banco de dados que contém dados de usuário personalizados.

  • collection_name string

    O nome da coleção que contém dados de usuário personalizado.

  • user_id_field string

    O nome de um campo que aparece em cada documento de dados de usuário personalizado e que contém o ID da conta de usuário do usuário correspondente de cada documento.

  • habilitado booleano

    Se true, os dados de usuário personalizado estão habilitados.

  • mongo_service_id string

    O valor _id de uma fonte de dados MongoDB vinculada.

    Você pode listar serviços com o endpoint Obter todos os serviços.

    As fontes de dados são serviços cujo type é "mongodb-atlas". Use o valor _id para a fonte de dados que você deseja vincular ao trigger.

  • on_user_creation_function_id string

    O valor de _id de uma função de criação de usuário que é executada sempre que um novo usuário se registra.

Respostas

  • 204

    Sucesso

PATCH /groups/{groupId}/apps/{appId}/custom_user_data 
curl \
 --request PATCH 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/custom_user_data' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"database_name":"myapp","collection_name":"users","user_id_field":"user_account_id","enabled":true,"mongo_service_id":"63c060ed32043ef4c93c2a9c","on_user_creation_function_id":"63c055d8019a6ab879f661d6"}'
Exemplos de solicitação 
{
  "database_name": "myapp",
  "collection_name": "users",
  "user_id_field": "user_account_id",
  "enabled": true,
  "mongo_service_id": "63c060ed32043ef4c93c2a9c",
  "on_user_creation_function_id": "63c055d8019a6ab879f661d6"
}