Definir metadatos de usuario personalizados

Navegue a la pantalla de configuración de datos de usuario personalizados

Haga clic App Users En el menú de navegación izquierdo, seleccione la pestaña User Settings y busque la sección Custom User Data.

Habilitar datos de usuario personalizados

Haga clic en el interruptor Enable Custom User Data para establecerlo en On.

haga clic para ampliar

Especificar la recopilación de datos de usuario personalizados

Debe almacenar los datos personalizados de los usuarios de su aplicación en una única colección de un clúster de MongoDB Atlas vinculado. Para configurar su aplicación para que lea los datos de usuario de esta colección, debe especificar los siguientes valores:

• Cluster Name:El nombre de un clúster MongoDB vinculado que contiene la colección de datos de usuario personalizada.

• Database Name:El nombre de la base de datos MongoDB que contiene la colección de datos de usuario personalizados.

• Collection Name:El nombre de la colección MongoDB que contiene datos de usuario personalizados.

haga clic para ampliar

Especifique el campo ID de usuario

Cada documento en la colección de datos de usuario personalizada tiene un campo que lo asigna a un usuario específico de la aplicación. El campo debe ser del tipo ObjectID o de un tipo string que represente ese ObjectID. Este campo debe estar presente en cada documento que se asocia a un usuario.

Especifique el nombre del campo que contiene el ID de cada usuario en la entrada User ID Field.

Definir una función de creación de usuarios (opcional)

Si desea utilizar una función de creación de usuarios, defínala en el editor en línea o haga referencia a una función existente por nombre.

Implementar la aplicación actualizada

Una vez configurada la recopilación de datos de usuario personalizados, puede ponerlos a disposición de las aplicaciones cliente mediante la implementación de su aplicación. Para implementar un borrador de aplicación desde la interfaz de usuario de App Services:

1. Haga clic en Deploy en el menú de navegación de la izquierda.

2. Busque el borrador en la tabla del historial de implementación y luego haga clic en Review & Deploy Changes.

3. Revise la diferencia de cambios y luego haga clic en Deploy.

Una vez que la aplicación se implemente con éxito, App Services comienza a asociar datos personalizados con los usuarios. Cuando un usuario inicia sesión, App Services consulta automáticamente la colección de datos de usuario personalizada por un documento donde el User ID Field especificado contiene el ID del usuario. Si un documento coincide, aplicación Services expone los datos del documento en el campo custom_data del objeto de usuario.

Obtenga la última versión de su aplicación

Para definir datos de usuario personalizados con appservices, necesita una copia local de los archivos de configuración de su aplicación.

Para extraer una copia local de la última versión de su aplicación, ejecute lo siguiente:

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

Configurar datos de usuario personalizados

Debe almacenar los datos personalizados de los usuarios de su aplicación en una única colección de un clúster Atlas vinculado. Cada documento de la colección debe incluir un campo específico que contenga el ID del usuario de App Services que describe.

Para configurar su aplicación para que lea datos de usuario de esta colección, defina un documento de configuración de datos de usuario personalizado /auth/custom_user_data.jsonen:

{
  "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>"
}

Implementar la configuración de datos de usuario personalizados

Una vez configurados los datos de usuario personalizados, puedes enviar la configuración actualizada a tu aplicación remota. La CLI de App Services implementa la actualización inmediatamente al enviarla.

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

Navegue a la pantalla de configuración del proveedor de autenticación

Puedes configurar y habilitar los metadatos de usuario en la interfaz de usuario de App Services. Para acceder a la página de configuración:

• Haga clic en Authentication en el menú de navegación de la izquierda.

• Seleccione la pestaña Authentication Providers.

• Presione el botón EDIT para el proveedor cuyos metadatos desea configurar.

Configurar metadatos del usuario

Google o Facebook

Selecciona las casillas junto a los campos de metadatos que deseas habilitar.

haga clic para ampliar

Autenticación JWT personalizada

Puedes especificar los campos de metadatos que admite tu proveedor de identidad. Después de presionar el botón Add Field, define:

• El camino

• El nombre del campo

• Si el campo es opcional u obligatorio

Para obtener más detalles, consulte: Campos de metadatos JWT.

haga clic para ampliar

Después de configurar los metadatos a los que desea acceder, presione el botón Save Draft.

Implementar la aplicación actualizada

Después de actualizar la configuración de metadatos, debe implementar su aplicación. Para implementar un borrador de aplicación desde la interfaz de usuario de App Services:

1. Haga clic en Deploy en el menú de navegación de la izquierda.

2. Busque el borrador en la tabla del historial de implementación y luego haga clic en Review & Deploy Changes.

3. Revise la diferencia de cambios y luego haga clic en Deploy.

Una vez implementada correctamente la aplicación, App Services comienza a asociar metadatos con los usuarios. Cuando un usuario inicia sesión, App Services le solicita permiso para acceder a los metadatos solicitados. Si el usuario lo aprueba, App Services expone los datos en su objeto de usuario.

Obtenga la última versión de su aplicación

Para actualizar su aplicación con appservices, necesita una copia local de sus archivos de configuración.

Para extraer una copia local de la última versión de su aplicación, ejecute lo siguiente:

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

Configurar campos de metadatos

Puedes encontrar los metadata_fields del proveedor de autenticación para tu aplicación /auth/providers.json en. Actualiza esta matriz para solicitar los metadatos del usuario al proveedor de autenticación.

Google o Facebook

Esta matriz se parece a:

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

Autenticación JWT personalizada

La matriz metadata_fields tiene una propiedad adicional, field_name. En la autenticación JWT personalizada, name representa la ruta al campo. field_name representa el nombre del campo.

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

Implementar la configuración de datos de usuario personalizados

Una vez configurados los datos de usuario personalizados, puedes enviar la configuración actualizada a tu aplicación remota. La CLI de App Services implementa la actualización inmediatamente al enviarla.

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

Autenticar un usuario de MongoDB Atlas

Llame al punto final de autenticación del usuario administrador con su par de claves API de 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>"
  }'

Si la autenticación es exitosa, el cuerpo de la respuesta contiene un objeto JSON con un valor access_token:

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

El access_token otorga acceso a la API de administración de App Services. Debe incluirlo como token de portador en el encabezado Authorization para todas las solicitudes de la API de administración.

Configurar campos de metadatos

Envíe una solicitud al punto final "Actualizar un proveedor de autenticación". En el cuerpo de la solicitud, defina metadata_fields para el proveedor.

Asegúrese de incluir su API de administración access_token, el groupId del proyecto Atlas que contiene su aplicación, la cadena hexadecimal interna appId de la aplicación y el valor _id del proveedor de autenticación:

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
  }'

Si configura correctamente los campos de metadatos del proveedor, App Services devuelve una respuesta 204.