Definir metadados personalizados do usuário

Navegue até a tela de configuração de dados de usuário personalizados

Clique em App Users no menu de navegação esquerdo. Em seguida, selecione a aba User Settings e encontre a seção Custom User Data .

Habilitar dados de usuário personalizados

Clique no botão Enable Custom User Data para defini-lo para On.

clique para ampliar

Especifique a collection de dados de usuário customizada

Você deve armazenar os dados personalizados dos usuários do seu aplicativo em uma coleção única de um cluster vinculado do MongoDB Atlas. Para configurar seu aplicativo para ler dados do usuário desta coleção, você precisa Especifique os seguintes valores:

• Cluster Name: O nome de um cluster MongoDB vinculado que contém a coleção de dados personalizados do usuário.

• Database Name: O nome do banco de dados MongoDB que contém a coleta de dados personalizada do usuário.

• Collection Name: o nome da collection do MongoDB que contém dados de usuário personalizado.

clique para ampliar

Especifique o campo ID do usuário

Cada documento na coleção personalizada de dados do usuário tem um campo que o mapeia para um usuário específico do aplicativo. O campo deve ser do tipo ObjectID ou um tipo string que represente esse ObjectID. Este campo deve estar presente em todos os documentos que mapeiam para um usuário.

Especifique o nome do campo que contém a ID de cada usuário na entrada User ID Field.

Definir uma função de criação de usuário (opcional)

Se você quiser usar uma função de criação de usuário, defina-a no editor incorporado ou faça referência a uma função existente pelo nome.

Distribuir o aplicativo atualizado

Depois de configurar a collection de dados de usuário customizada, é possível disponibilizar os dados personalizados do usuário para os aplicativos clientes implementando o aplicativo. Para implementar um rascunho de aplicativo a partir da UI do App Services:

1. Clique em Deploy no menu de navegação esquerdo.

2. Encontre o rascunho na tabela de histórico de implementação e clique em Review & Deploy Changes.

3. Revise a diferença de alterações e clique em Deploy.

Depois que o aplicativo for implementado corretamente, o App Services começa a associar dados personalizados aos usuários. Quando um usuário faz se conecta, o App Services faz query automaticamente à collection de dados de usuário customizada em busca de um documento em que o User ID Field especificado contém o ID do usuário. Se um documento corresponder, o App Services expõe os dados no documento no campo custom_data do objeto de usuário desse usuário.

Obtenha a versão mais recente da sua aplicação

Para definir dados de usuário personalizados com appservices, você precisa de uma cópia local dos arquivos de configuração do seu aplicativo.

Para extrair uma cópia local da versão mais recente do seu aplicativo, execute o seguinte:

appservices pull --remote="<Your App ID>"

Configurar dados de usuário personalizados

Você deve armazenar os dados personalizados para os usuários do seu aplicativo em uma única coleção de um Atlas cluster vinculado. Cada documento na coleção deve incluir um campo específico que contenha o ID do usuário do usuário dos App Services que ele descreve.

Para configurar seu aplicação para ler dados de usuário desta coleção, defina um documento de configuração de dados de usuário personalizado no /auth/custom_user_data.json:

{
  "enabled": <Boolean>,
  "mongo_service_name": "<MongoDB Data Source Name>",
  "database_name": "<Database Name>",
  "collection_name": "<Collection Name>",
  "user_id_field": "<User ID Field Name>",
  "on_user_creation_function_name": "<Function Name>"
}

Implemente a configuração de dados de usuário customizada

Depois de configurar os dados personalizados do usuário, você pode enviar a configuração atualizada para o aplicativo remoto. O App Services CLI implementa imediatamente a atualização no push.

appservices push --remote="<Your App ID>"

Navegue até a tela de configuração do fornecedor de autenticação

Você pode configurar e habilitar os metadados do usuário na interface do usuário do App Services. Para acessar a página de configuração:

• Clique em Authentication no menu de navegação esquerdo.

• Selecione a guia Authentication Providers.

• Pressione o botão EDIT do provedor cujos metadados você deseja configurar.

Configurar metadados do usuário

Google ou Facebook

Marque as caixas de seleção ao lado dos campos de metadados que você deseja habilitar.

clique para ampliar

Autenticação JWT personalizada

Você pode especificar os campos de metadados aceitos pelo seu fornecedor de identidade. Depois de pressionar o botão Add Field, defina:

• O caminho

• O nome do campo

• Se o campo é opcional ou obrigatório

Para obter mais detalhes, consulte Campos de metadados JWT.

clique para ampliar

Depois de configurar os metadados que pretende acessar, pressione o botão Save Draft .

Distribuir o aplicativo atualizado

Após atualizar a configuração de metadados, você deve implantar seu aplicativo. Para implementar um rascunho de aplicativo a partir da interface do usuário do App Services:

1. Clique em Deploy no menu de navegação esquerdo.

2. Encontre o rascunho na tabela de histórico de implementação e clique em Review & Deploy Changes.

3. Revise a diferença de alterações e clique em Deploy.

Depois que o aplicativo é implantado com sucesso, o App Services começa a associar metadados aos usuários. Quando um usuário faz login, o App Services solicita permissão do usuário para acessar os metadados solicitados. Se o usuário aprovar, os Serviços de Aplicativo expõem os dados no objeto de usuário desse usuário.

Obtenha a versão mais recente da sua aplicação

Para atualizar seu aplicativo com serviços de aplicativo, você precisa de uma cópia local de seus arquivos de configuração.

Para extrair uma cópia local da versão mais recente do seu aplicativo, execute o seguinte:

appservices pull --remote="<Your App ID>"

Configurar campos de metadados

Você pode encontrar metadata_fields do provedor de autenticação para sua aplicação em /auth/providers.json. Atualize esta array para solicitar metadados do usuário do provedor de autenticação.

Google ou Facebook

Esta array se assemelha a:

{ ...other config details...
  "metadata_fields": [
    {
      "required": false,
      "name": "name"
    },
    {
      "required": false,
      "name": "gender"
    }
  ]
}

Autenticação JWT personalizada

A array metadata_fields tem uma propriedade adicional, field_name. Na autenticação JSON web token personalizado, name representa o caminho para o campo. O field_name representa o nome do campo.

{ ...other config details...
  "metadata_fields": [
    {
      "required": true,
      "name": "user.name",
      "field_name": "name"
    },
    {
      "required": false,
      "name": "user.favoriteColor",
      "field_name": "favoriteColor"
    }
  ]
}

Implemente a configuração de dados de usuário customizada

Depois de configurar os dados personalizados do usuário, você pode enviar a configuração atualizada para o aplicativo remoto. O App Services CLI implementa imediatamente a atualização no push.

appservices push --remote="<Your App ID>"

Autenticar um usuário do MongoDB Atlas

Chame o endpoint de autenticação do usuário administrador com seu par de chaves da API do MongoDB Atlas:

curl -X POST \
  https://services.cloud.mongodb.com/api/admin/v3.0/auth/providers/mongodb-cloud/login \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d '{
    "username": "<Public API Key>",
    "apiKey": "<Private API Key>"
  }'

Se a autenticação for bem-sucedida, o corpo da resposta conterá um objeto JSON com um valor access_token :

{
  "access_token": "<access_token>",
  "refresh_token": "<refresh_token>",
  "user_id": "<user_id>",
  "device_id": "<device_id>"
}

O access_token concede acesso à App Services Admin API. Você deve incluí-lo como um token do portador no cabeçalho Authorization para todas as solicitações de API Admin.

Configurar campos de metadados

Envie uma solicitação para o endpoint Atualizar um provedor de autenticação . No corpo da solicitação, defina metadata_fields para o provedor.

Certifique-se de incluir sua API Admin access_token, o groupId do projeto Atlas que contém seu aplicativo, a string hexadecimal appId interna do aplicativo e o valor _id do provedor de autenticação:

curl --request PATCH 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/auth_providers/{providerId}' \
  --header 'Authorization:  Bearer <access_token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "_id": "<Provider ID>",
    "name": "oauth2-facebook",
    "type": "oauth2-facebook",
    "redirect_uris": ["https://example.com/"],
    "config": {
      "clientId": "<Facebook Client ID>"
    },
    "secret_config": {
      "clientSecret": "<Facebook Client Secret Name>"
    },
    "metadata_fields": [
      { "required": false, "name": "name" },
      { "required": true, "name": "first_name" },
      { "required": true, "name": "last_name" },
      { "required": false, "name": "picture" },
      { "required": false, "name": "gender" },
      { "required": false, "name": "birthday" },
      { "required": false, "name": "min_age" },
      { "required": false, "name": "max_age" },
      { "required": false, "name": "email" }
    ],
    "disabled": false
  }'

curl --request PATCH 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/auth_providers/{providerId}' \
  --header 'Authorization:  Bearer <access_token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "_id": "<Provider ID>",
    "name": "oauth2-google",
    "type": "oauth2-google",
    "redirect_uris": ["https://example.com/"],
    "config": {
      "clientId": "<Google Client ID>"
    },
    "secret_config": {
      "clientSecret": "<Google Client Secret Name>"
    },
    "metadata_fields": [
      { "required": false, "name": "name" },
      { "required": true, "name": "first_name" },
      { "required": true, "name": "last_name" },
      { "required": false, "name": "picture" },
      { "required": false, "name": "gender" },
      { "required": false, "name": "birthday" },
      { "required": false, "name": "min_age" },
      { "required": false, "name": "max_age" },
      { "required": false, "name": "email" }
    ],
    "disabled": false
  }'

curl --request PATCH 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/auth_providers/{providerId}' \
  --header 'Authorization:  Bearer <access_token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "_id": "<Provider ID>",
  "name": "custom-token",
  "type": "custom-token",
  "metadata_fields": [
    {
      "required": true,
      "name": "jwt.field.path",
      "field_name": "metadataFieldName"
    }
  ],
  "config": {
    "audience": [],
    "requireAnyAudience": false,
    "signingAlgorithm": "HS256",
    "useJWKURI": false
  },
  "secret_config": {
    "signingKeys": [
      "<JWT Signing Key>"
    ]
  },
  "disabled": true
  }'

Se você configurar com sucesso os campos de metadados do provedor, o App Services retornará uma resposta 204 .