Configuración de Confluence Cloud

Versión preliminar pública: La búsqueda federada está en versión preliminar pública. Esta función está sujeta a las “Condiciones de la Oferta de la Fase Previa a la DG” en la sección de Condiciones Generales del Servicio de las Condiciones Específicas del Servicio. Las funciones de la fase previa a la DG están disponibles “sin modificaciones” y pueden tener asistencia limitada. Para obtener más información, consulta las descripciones de la etapa de lanzamiento.

En esta página, se describe cómo configurar tu instancia de Confluence Cloud antes de crear el almacén de datos de Confluence Cloud.

Configura la autenticación y los permisos

Debes configurar la autenticación y los permisos en el centro de cuentas de administrador de Atlassian. Esto es fundamental para permitir que el conector acceda a los datos y los sincronice. El conector de Confluence Cloud admite varios métodos de autenticación, como credenciales de cliente de OAuth o tokens de API.

Crea una app de OAuth 2.0

Para crear una app de OAuth 2.0 para la autenticación, sigue estos pasos para configurar la aplicación en la consola para desarrolladores de Atlassian y obtener el ID de cliente y el secreto del cliente necesarios.

Verifica el acceso de administrador de la organización de Confluence

Para verificar el acceso de administrador de la organización de Confluence, haz lo siguiente:

1. Accede a Atlassian con tus credenciales de usuario.

2. Selecciona la app de Confluence.

3. Haz clic en Configuración.

   Si ves la opción Sistema en Configuración de Confluence, tienes acceso de administrador de la organización de Confluence. De lo contrario, pídele al administrador de tu organización de Confluence que te proporcione acceso.

Crea una app de OAuth 2.0

Para crear una app de OAuth 2.0, haz lo siguiente:

1. Accede a la Consola para desarrolladores de Atlassian.

2. Haz clic en el ícono de perfil y selecciona Consola para desarrolladores.

3. En la página Console, haz clic en Create y selecciona OAuth 2.0 Integration.

4. En la página de creación de la app, haz lo siguiente:

   1. Ingresa un nombre para la app.

   2. Selecciona la casilla de verificación para aceptar las condiciones para desarrolladores de Atlassian.

   3. Haz clic en Crear.

5. En la página de la app, haz lo siguiente:

   1. En el menú de navegación, haz clic en Autorización.

   2. En la tabla Tipo de autorización, selecciona Agregar para OAuth 2.0 (3LO).

6. En el campo URL de devolución de llamada, ingresa https://vertexaisearch.cloud.google.com/console/oauth/confluence_oauth.html.

7. Haz clic en Guardar cambios.

Obtén el ID de cliente y el secreto del cliente

Para obtener el ID de cliente y el secreto del cliente, haz lo siguiente:

1. En la página de la app, haz clic en Distribución en el menú de navegación.

2. En la página Distribución, haz lo siguiente:

   1. En la sección Controles de distribución, selecciona Editar.
   2. En la sección Estado de distribución, selecciona Compartir para habilitar la edición de otros campos.
   3. Ingresa la información en los siguientes campos obligatorios:
      1. En Proveedor, ingresa Google.
      2. En Política de privacidad, ingresa https://policies.google.com.
      3. En ¿Tu app almacena datos personales?, selecciona Sí.
      4. Selecciona la casilla de verificación Confirmo que implementé la API de informes de datos personales.
   4. Haz clic en Guardar cambios.

3. En la página de la app, haz lo siguiente:

   1. En el menú de navegación, haz clic en Configuración.
   2. En la página de configuración, copia tu ID de cliente y tu secreto del cliente.

Obtén un ID y una URL de instancia

1. Obtén el ID de instancia:

   1. Abre una pestaña nueva, copia la URL de la instancia y agrega /_edge/tenant_info a esa URL. Por ejemplo, https://YOUR_INSTANCE.atlassian.net/_edge/tenant_info
   2. Navega al vínculo para encontrar el valor de cloudId. El cloudId es el ID de tu instancia.

2. Obtén la URL de instancia:

   1. Ve a atlassian.net y accede con tu cuenta de administrador.
   2. Selecciona la app que quieras sincronizar. Por ejemplo, sincroniza la primera app.
   3. Busca la URL de la instancia (el subdominio en la barra de direcciones).

Otorga roles de administrador

Para otorgar al administrador de Confluence el rol de editor de Discovery Engine en la consola de Google Cloud , haz lo siguiente:

1. En la consola de Google Cloud , ve a la página Gemini Enterprise.

2. Navega a IAM.

   Ir a IAM

3. Busca la cuenta de usuario que tiene acceso de administrador en Confluence y haz clic en el ícono para editar .

4. Otórgale el rol de Editor de Discovery Engine al administrador.

Para otorgarle a un usuario un rol de administrador en Atlassian, haz lo siguiente:

1. Accede a Atlassian con una cuenta de administrador de la organización.

2. Haz clic en el ícono de menú y selecciona tu organización. También puedes ir a admin.atlassian.com.

3. En la página Administrador, haz clic en el producto y selecciona el botón Administrar usuarios.

4. Haz clic en Grupos en Administración de usuarios.

5. En la página Grupos, haz lo siguiente:

   1. Haz clic en Crear grupo.
   2. Ingresa un nombre para el grupo.

Este grupo recibe los permisos que requiere el conector. Los usuarios que se agreguen a este grupo heredarán estos permisos. El conector usa este grupo para autenticarse y recuperar documentos.

1. En la página del grupo, haz clic en Agregar producto.

2. Selecciona Administrador de acceso de usuarios como el rol para Confluence.

3. Selecciona Administrador de productos como el rol para Administración de Confluence.

4. Haz clic en Otorgar acceso.

5. Haz clic en Agregar miembros del grupo para agregar una cuenta de usuario o miembros del grupo que el conector usa para autenticarse y acceder a los recursos necesarios.

Configura los permisos mínimos de la aplicación

Para configurar OAuth 2.0 y recuperar las credenciales necesarias para la configuración de tu conector de Confluence, haz lo siguiente:

1. Habilita OAuth 2.0:
   1. Haz clic en Permisos.
   2. Ve a la API de Confluence.
   3. Haz clic en Agregar.
   4. Haz clic en Configurar.
   5. Ve a la pestaña Permisos detallados y haz clic en Editar permisos.
   6. Selecciona los siguientes permisos.
      • read:attachment:confluence
      • read:configuration:confluence
      • read:content.metadata:confluence
      • read:content-details:confluence
      • read:whiteboard:confluence
      • read:group:confluence
      • read:space:confluence
      • read:user:confluence
      • search:confluence
      • write:page:confluence
      • write:attachment:confluence
   7. Confirma que estén seleccionados todos los permisos y guarda los cambios.

Configura un token de API en Confluence

Si planeas usar un token de API para la autenticación, debes crear un token de API sin permisos. Este conector no admite tokens de API con permisos.

1. Accede a Atlassian Console.
2. Haz clic en Crear token de API.
3. Ingresa un nombre para el token de API.
4. Selecciona una fecha de vencimiento para el token de API. El período de vencimiento del token varía de 1 a 365 días.
5. Haz clic en Crear.
6. Guarda el token para usarlo más adelante.

Administra la visibilidad de los usuarios

Para que el correo electrónico del usuario sea visible para cualquier persona de la cuenta de Atlassian, sigue estos pasos:

1. Accede a la Consola para desarrolladores de Atlassian.

2. Haz clic en el ícono de perfil y selecciona Consola para desarrolladores.

3. Haz clic en el ícono de perfil del usuario y selecciona Administrar cuenta.

4. Navega a Perfil y visibilidad.

5. Ve a Contacto y establece Quién puede ver esto como Cualquiera.

Para que el correo electrónico del usuario sea visible para cualquier persona en Confluence, sigue estos pasos:

1. Accede a Atlassian con tus credenciales de usuario.

2. Selecciona una app de Confluence.

3. Haz clic en Configuración > Sistema.

4. Selecciona Configuración general en el panel izquierdo.

5. Haga clic en Edit Settings.

6. En Visibilidad del correo electrónico del usuario, selecciona Público.

7. Haz clic en Actualizar.

Instala y configura User Identity Accessor for Confluence Cloud

Si las direcciones de correo electrónico de los usuarios no son accesibles de forma pública de forma predeterminada debido a la configuración de privacidad en Confluence Cloud, debes instalar la aplicación User Identity Accessor for Confluence Cloud para recuperar de forma segura las direcciones de correo electrónico de los usuarios. Si las direcciones de correo electrónico de los usuarios ya son visibles públicamente, es posible que no necesites instalar la aplicación. Para obtener más información sobre la visibilidad restringida del correo electrónico, consulta Cómo administrar la visibilidad de los usuarios y otorgar roles.

Roles y permisos

Para instalar y configurar la aplicación User Identity Accessor for Confluence Cloud, debes tener el rol de administrador adecuado y otorgar los permisos necesarios a nivel de la aplicación.

• Rol requerido: Debes ser Confluence Site administrator para instalar y configurar la aplicación.
• Permisos a nivel de la aplicación: Debes otorgar los siguientes permisos durante la instalación de la aplicación:
  • Read Email Address: Permite que la aplicación recupere de forma segura las direcciones de correo electrónico de los usuarios, incluso cuando la visibilidad del perfil está restringida.
  • App Storage scope: Permite que la aplicación lea y escriba en su dispositivo de almacenamiento.

Instala User Identity Accessor for Confluence Cloud

Para instalar la aplicación de User Identity Accessor for Confluence Cloud en tu sitio de Confluence, sigue estos pasos:

1. Navega a la Consola para desarrolladores de Atlassian.

2. Revisa los permisos de Leer dirección de correo electrónico y Alcance de almacenamiento de la app, y haz clic en Obtener la app.

3. En la lista Selecciona un sitio en el que instalar esta app, elige el sitio de Confluence en el que deseas instalar la app. En esta lista, solo se muestran los sitios a los que tienes acceso de administrador.

   Nota: Debes tener el rol de administrador de al menos un sitio de Confluence para instalar la app.

4. Haz clic en Instalar para completar la instalación de la app.

Configura User Identity Accessor for Confluence Cloud

Después de instalar la aplicación User Identity Accessor for Confluence Cloud, configura una clave de API que tu sistema externo (por ejemplo, tu Confluence Cloud Connector) use para llamar de forma segura al activador web de la app y recuperar correos electrónicos.

Accede a la página de configuración

Para acceder a la página de configuración de la aplicación User Identity Accessor for Confluence Cloud en Confluence Cloud, sigue estos pasos:

1. En tu instancia de Confluence Cloud, haz clic en el ícono de Configuración ⚙️ en el menú de navegación.
2. Selecciona Apps en el menú.
3. En la página Administración de apps, busca tu app, User Identity Accessor para Confluence Cloud, en la lista Administrar apps.
4. Haz clic en Configurar o en el vínculo asociado a tu app. Se abrirá la página de configuración dedicada de la app en Confluence.

Configura la clave de API

Para configurar la clave de API en la página de configuración, sigue estos pasos:

1. En la sección Configuración de la clave de API, especifica la clave secreta para autenticar las solicitudes al activador web de la app. Puedes autenticar solicitudes con cualquiera de los siguientes métodos:

   • Ingresa tu propia clave: Escribe o pega tu propia clave de API segura y única en el campo Clave de API. Usa una clave de al menos 20 a 30 caracteres con una combinación de letras mayúsculas, letras minúsculas, números y símbolos.

   • Generar una clave: Haz clic en el botón Generar clave nueva. El sistema genera y muestra una clave aleatoria y segura en el campo.

     Importante: Copia de inmediato la clave de API que se muestra en el campo. Por motivos de seguridad, es posible que no puedas volver a ver la clave completa después de guardarla o salir de la página. Si la pierdes, deberás establecer o generar una nueva.

2. Haz clic en Guardar clave de API. Un mensaje de éxito confirma que la clave se guardó de forma segura.

Nota: La clave de API que se genera o crea en esta sección sirve como valor para el campo Secreto del cliente de Confluence Identity Sync Forge en la sección Opciones avanzadas durante la configuración del conector.

Prueba la configuración de la app

Verifica que la app User Identity Accessor for Confluence Cloud esté configurada correctamente. Para ello, envía una solicitud desde tu sistema externo y confirma que las direcciones de correo electrónico del usuario se devuelvan correctamente.

Obtén la URL del activador web

1. En la página Administración de apps, busca la sección URL de Webtrigger, que muestra la URL única específica de tu sitio de Confluence y de la instalación de esta app:
   • Tu sistema externo debe llamar a esta URL para solicitar correos electrónicos de los usuarios. Por ejemplo, https://YOUR_INSTANCE_ID.hello.atlassian-dev.net/x1/WEBTRIGGER_ID, en el que YOUR_INSTANCE_ID es el identificador de tu instancia de Confluence Cloud y WEBTRIGGER_ID es el identificador único del extremo de webtrigger generado para tu app.
2. Haz clic en el botón Copiar URL o copia la URL completa.

Configura tu sistema externo

• Configura tu sistema externo que necesita recuperar correos electrónicos de usuarios de Confluence con la clave de API y la URL de Webtrigger que obtuviste en los pasos anteriores.

  • URL del extremo: Es la URL del activador web que copiaste.
  • Método HTTP: POST

  • Encabezados obligatorios:

    • Content-Type: application/json

    • X-Api-Key: YOUR_API_KEY

      Reemplaza YOUR_API_KEY por la clave de API que configuraste o generaste en la sección Configura la clave de API

Ejemplo del comando curl

En este ejemplo, se muestra cómo llamar al activador web User Identity Accessor for Confluence Cloud, que acepta un array de IDs de cuentas y devuelve las direcciones de correo electrónico.

curl --location --request POST 'https://YOUR_INSTANCE_ID.hello.atlassian-dev.net/x1/ENDPOINT_PATH' \
--header 'X-Api-Key: YOUR-API-KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
   "accountIds": [
       "ACCOUNT_ID_1",
       "ACCOUNT_ID_2"
   ]
}'

Reemplaza lo siguiente:

• YOUR_INSTANCE_ID por el ID de tu instancia de Confluence Cloud
• ENDPOINT_PATH por la ruta de acceso del extremo de API
• YOUR_API_KEY por la clave de API que configuraste o generaste en la sección Configura la clave de API
• ACCOUNT_ID con los IDs de las cuentas de Atlassian a las que deseas segmentar

Respuesta esperada

[{"accountId":"ACCOUNT_ID_1","emailAddress":"EMAIL_ADDRESS_1"},
 {"accountId":"ACCOUNT_ID_2","emailAddress":"EMAIL_ADDRESS_2"}]

Reemplaza lo siguiente:

• ACCOUNT_ID_X con IDs de cuentas de Atlassian reales
• USER_EMAIL_X con las direcciones de correo electrónico de los usuarios que se muestran en la llamada a la API

Implementa las prácticas recomendadas de seguridad

Para confirmar la seguridad de tu clave de API, sigue estas recomendaciones:

• Almacena la clave de API de forma segura en la configuración de tu conector de Confluence Cloud.
• Verifica que toda la comunicación con la URL del webhook se realice a través de HTTPS. Este es el valor predeterminado para los activadores web de User Identity Accessor for Confluence Cloud.

Compatibilidad con User Identity Accessor for Confluence Cloud

Google ofrece asistencia para la aplicación de User Identity Accessor for Confluence Cloud, que puede incluir mantenimiento y actualizaciones periódicas para mantener la app actualizada. Si tienes algún problema o pregunta específica sobre las funciones de la aplicación, comunícate con el equipo de asistencia deGoogle Cloud .