Archivos de configuración de proveedor de usuario y autenticación

Atlas App Services ha llegado al final de su ciclo de vida y MongoDB ya no ofrece soporte activo. Los activadores siguen disponibles en la interfaz de usuario de Atlas. Consulte Página de desuso para más detalles.

Nota

Esta página describe un formato de archivo de configuración heredado. Solo debe usar esta información si está usando el formato obsoleto. realm-cli.

Cualquier archivo de configuración que extraiga con la CLI de App Services o exporte desde la interfaz de usuario utiliza la versión más reciente. Para obtener información detallada sobre el formato actual de los archivos de configuración, consulte Configuración de la aplicación.

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

Proveedores de autenticación

Configuración

Puede habilitar y configurar proveedores de autenticación en /auth/providers.json.

Cada campo de la configuración es el nombre de un tipo de proveedor y contiene un objeto de configuración para dicho proveedor. Las configuraciones de los proveedores de autenticación comparten una estructura común, pero cada tipo de proveedor utiliza un conjunto único de campos de configuración.

Tip

Puede encontrar información detallada sobre la configuración de un proveedor específico en su página de referencia. Para ver una lista completa de las páginas de referencia, consulte Proveedores de autenticación.

/auth/proveedores.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	Descripción
`name` String	El nombre del proveedor de autenticación. Siempre será el mismo que el `type` del proveedor.
`type` String	El tipo de proveedor de autenticación. Opciones válidas: `"anon-user"` para autenticación anónima. `"local-userpass"` para la autenticación de correo electrónico/contraseña. `"api-key"` para la autenticación de clave API. `"custom-token"` para la autenticación JWT personalizada. `"custom-function"` para la autenticación de funciones personalizadas. `"oauth2-google"` para la autenticación de Google. `"oauth2-facebook"` para la autenticación de Facebook. `"oauth2-apple"` para la autenticación de ID de Apple.
`disabled` Boolean	Si es `true`, este proveedor de autenticación no está habilitado para su aplicación. Los usuarios no pueden iniciar sesión con las credenciales de un proveedor deshabilitado.
`config` Document	Un documento que contiene valores de configuración específicos del proveedor de autenticación. Las siguientes configuraciones de proveedor incluyen `config`: Correo electrónico/Contraseña JWT personalizado Función personalizada Google Facebook ID de Apple
`secret_config` Document	Un documento donde cada nombre de campo es un campo de configuración privado para el proveedor y el valor de cada campo es el nombre de un secreto que almacena el valor de configuración. Las siguientes configuraciones de proveedor incluyen `redirect_uris`: JWT personalizado Google Facebook ID de Apple
`metadata_fields` Array<Document>	Una matriz de documentos donde cada documento define un campo de metadatos que describe al usuario. La existencia de este campo y el formato exacto de cada documento de campo de metadatos dependen del tipo de proveedor. Las siguientes configuraciones de proveedor incluyen `metadata_fields`: JWT personalizado Google Facebook
`redirect_uris` Array<String>	Una lista de URL a las que Atlas App Services puede redirigir al usuario después de completar una autorización OAuth. Las siguientes configuraciones de proveedor incluyen `redirect_uris`: Google Facebook ID de Apple

Datos de usuario personalizados

Puede configurar la recopilación de datos de usuario personalizados para su aplicación /auth/custom_user_data.json en.

/auth/datos_de_usuario_personalizados.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>"
}

Nombre de campo	Descripción
`enabled` Boolean	Si es `true`, App Services asocia cada usuario con un documento en la colección especificada que contiene sus datos personalizados.
`mongo_service_name` String	El nombre de la fuente de datos que contiene la recopilación de datos de usuario personalizados.
`database_name` String	El nombre de la base de datos que contiene la recopilación de datos de usuario personalizados.
`collection_name` String	El nombre de la colección que contiene los datos de usuario personalizados.
`user_id_field` String	El nombre del campo en los documentos de datos de usuario personalizados que contiene el ID de usuario del usuario de la aplicación que describe el documento.
`on_user_creation_function_name` String	El nombre de la función de creación de usuario.

¿Qué son los servicios de aplicación Atlas?