Menu Docs
Página inicial do Docs
/
MongoDB Atlas
/
Serviços Atlas App

Arquivos de configuração do provedor de autenticação e usuário

Nesta página

  • Provedores de autenticação
  • Configuração
  • Usuário de dados personalizado

Observação

Esta página descreve um formato de arquivo de configuração legado. Você só deve usar essas informações se estiver usando o realm-cli obsoleto.

Todos os arquivos de configuração que você extrai com o App Services CLI ou exporta da UI utilizam a versão de configuração mais recente. Para obter informações detalhadas sobre o formato do arquivo de configuração atual, consulte Configuração do aplicativo.

app/
└── auth/
    ├── providers.json
    └── custom_user_data.json

Provedores de autenticação

Configuração

Você pode habilitar e configurar provedores de autenticação no /auth/providers.json.

Cada campo da configuração é o nome de um tipo de provedor e contém um objeto de configuração para este provedor. As configurações do fornecedor de autenticação compartilham uma estrutura comum, mas cada tipo de fornecedor utiliza um conjunto exclusivo de campos de configuração.

Dica

Você pode encontrar informações detalhadas sobre a configuração de um fornecedor específico na página de referência do fornecedor. Para obter uma lista de todas as páginas de referência do fornecedor, consulte provedor de autenticação.

/auth/providers.json
{
  "<Provider Name>": {
    "name": "<Provider Name>",
    "type": "<Provider Type>",
    "disabled": <Boolean>,
    "config": {
      "<Configuration Option>": "<Configuration Value>"
    },
    "secret_config": {
      "<Configuration Option>": "<Secret Name>"
    },
    "metadata_fields": [
      {
        "required": <Boolean>,
        "name": "Field Name"
      },
      ...
    ],
    "redirect_uris": ["<Application Redirect URI>", ...]
  },
  ...
}
Campo
Descrição
name
String
O nome do fornecedor de autenticação. Sempre será igual ao type do provedor.
type
String

O tipo do provedor de autenticação.

Opções válidas:

  • "anon-user" para autenticação anônima .

  • "local-userpass" para autenticação por e- mail/senha .

  • "api-key" para autenticação de chave de API .

  • "custom-token" para autenticação JSON web token personalizada .

  • "custom-function" para autenticação de Função Personalizada .

  • "oauth2-google" para autenticação do Google .

  • "oauth2-facebook" para autenticação do Facebook .

  • "oauth2-apple" para autenticação do ID Apple .

disabled
Boolean
Se true, este provedor de autenticação não está habilitado para a sua aplicação. Os usuários não podem se conectar usando credenciais de um fornecedor desativado.
config
Document

Um documento que contém valores de configuração específicos para o provedor de autenticação.

As seguintes configurações de provedor incluem config:

secret_config
Document

Um documento em que cada nome de campo é um campo de configuração privada para o provedor e o valor de cada campo é o nome de um segredo que armazena o valor de configuração.

As seguintes configurações de provedor incluem redirect_uris:

metadata_fields
Array<Document>

Uma array de documentos, onde cada documento define um campo de metadados que descreve o usuário. A existência deste campo e o formato exato de cada documento de campo de metadados dependem do tipo de fornecedor.

As seguintes configurações de provedor incluem metadata_fields:

redirect_uris
Array<String>

Uma lista de URL para as quais o Atlas App Services pode redirecionar o usuário de volta depois de concluir uma autorização.

As seguintes configurações de provedor incluem redirect_uris:

Usuário de dados personalizado

Você pode configurar a collection de dados de usuário personalizada para sua aplicação em /auth/custom_user_data.json.

/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": "<Field Name>",
  "on_user_creation_function_name": "<Function Name>"
}
Nome do campo
Descrição
enabled
Boolean
Se true, o App Services associa cada usuário a um documento na collection especificada que contém seus dados personalizados.
mongo_service_name
String
O nome do conjunto de dados que contém a collection de dados de usuário personalizada.
database_name
String
O nome do reconhecimento de data center que contém a collection de dados de usuário personalizada.
collection_name
String
O nome da collection que contém os dados de usuário personalizados.
user_id_field
String
O nome do campo em documentos de dados personalizados que contém o ID do usuário da aplicação que o documento descreve.
on_user_creation_function_name
String

Próximo

O que são os Serviços de Aplicativo Atlas?