En esta página se describe cómo configurar su instancia de Confluence Cloud antes de crear el almacén de datos de Confluence Cloud.
Configurar la autenticación y los permisos
Debe configurar la autenticación y los permisos en el centro de cuentas de administrador de Atlassian. Esto es fundamental para que el conector pueda acceder a los datos y sincronizarlos. El conector de Confluence Cloud admite varios métodos de autenticación, como las credenciales de cliente de OAuth o los tokens de API.
Crear una aplicación OAuth 2.0
Para crear una aplicación OAuth 2.0 para la autenticación, sigue estos pasos para configurar la aplicación en la consola de desarrollo de Atlassian y obtener el ID de cliente y el secreto de cliente necesarios.
Verificar 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:
Inicia sesión en Atlassian con tus credenciales de usuario.
Selecciona la aplicación Confluence.
Haz clic en Settings (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, pide al administrador de tu organización de Confluence que te proporcione acceso.
Crear una aplicación OAuth 2.0
Para crear una aplicación OAuth 2.0, sigue estos pasos:
Inicia sesión en la consola de desarrolladores de Atlassian.
Haz clic en el icono de perfil y selecciona Consola de Google Play.
En la página Console (Consola), haga clic en Create (Crear) y seleccione OAuth 2.0 Integration (Integración de OAuth 2.0).
En la página de creación de la aplicación, haz lo siguiente:
Introduce un nombre para la aplicación.
Marca la casilla para aceptar los términos para desarrolladores de Atlassian.
Haz clic en Crear.
En la página de la aplicación, haz lo siguiente:
En el menú de navegación, haga clic en Autorización.
En la tabla Tipo de autorización, selecciona Añadir en OAuth 2.0 (3LO).
En el campo URL de retrollamada, introduce
https://vertexaisearch.cloud.google.com/console/oauth/confluence_oauth.html.Haz clic en Guardar cambios.
Obtener el ID y el secreto de cliente
Para obtener el ID de cliente y el secreto de cliente, sigue estos pasos:
- En la página de la aplicación, vaya al menú de navegación y haga clic en Distribución.
En la página Distribución, haz lo siguiente:
- En la sección Controles de distribución, selecciona Editar.
- En la sección Estado de distribución, selecciona Compartir para habilitar la edición de otros campos.
- Introduce la información en los siguientes campos obligatorios:
- En Proveedor, escribe
Google. - En Política de Privacidad, introduce
https://policies.google.com. - En ¿Almacena su aplicación datos personales?, seleccione Sí.
- Marca la casilla Confirmo que he implementado la API de informes de datos personales.
- En Proveedor, escribe
- Haz clic en Guardar cambios.
En la página de la aplicación, haz lo siguiente:
- En el menú de navegación, haga clic en Configuración.
- En la página de configuración, copia el ID de cliente y el secreto de cliente.
Obtener un ID y una URL de instancia
Obtén el ID de instancia:
- Abre una pestaña nueva, copia la URL de la instancia y añade
/_edge/tenant_infoa la URL de la instancia. Por ejemplo,https://YOUR_INSTANCE.atlassian.net/_edge/tenant_info. - Ve al enlace para encontrar el valor de
cloudId. ElcloudIdes tu ID de instancia.
- Abre una pestaña nueva, copia la URL de la instancia y añade
Obtén la URL de la instancia:
- Ve a atlassian.net e inicia sesión con tu cuenta de administrador.
- Selecciona la aplicación que quieras sincronizar. Por ejemplo, sincroniza la primera aplicación.
- Busca la URL de la instancia (el subdominio de la barra de direcciones).
Asignar roles de administrador
Para conceder el rol Editor de Discovery Engine al administrador de Confluence en la consola Google Cloud , sigue estos pasos:
- En la Google Cloud consola, ve a la página Gemini Enterprise.
Ve a Gestión de identidades y accesos.
Busca la cuenta de usuario que tenga acceso de administrador en Confluence y haz clic en el icono Editar .
Asigna el rol Editor de Discovery Engine al administrador.
Para asignar a un usuario el rol de administrador en Atlassian, sigue estos pasos:
Inicia sesión en Atlassian con una cuenta de administrador de la organización.
Haz clic en el icono de menú y selecciona tu organización. También puedes ir a admin.atlassian.com.
En la página Administrar, haga clic en el producto y seleccione el botón Gestionar usuarios.
En Gestión de usuarios, haz clic en Grupos.
En la página Grupos:
- Haz clic en Crear grupo.
- Da un nombre al grupo.
Este grupo recibe los permisos que necesita el conector. Los usuarios que se añadan a este grupo heredarán estos permisos. El conector usa este grupo para autenticarse y obtener documentos.
En la página del grupo, haga clic en Añadir producto.
Selecciona Administrador de acceso de usuarios como rol de Confluence.
Selecciona Administrador de producto como rol de administración de Confluence.
Haz clic en Conceder acceso.
Haz clic en Añadir miembros del grupo para añadir una cuenta de usuario o miembros del grupo que el conector utilice para autenticarse y acceder a los recursos necesarios.
Configurar los permisos mínimos de la aplicación
Para configurar OAuth 2.0 y obtener las credenciales necesarias para configurar tu conector de Confluence, sigue estos pasos:
- Habilita OAuth 2.0:
- Haz clic en Permisos.
- Ve a la API de Confluence.
- Haz clic en Añadir.
- Haz clic en Configurar.
- Ve a la pestaña Ámbitos granulares y haz clic en Editar ámbitos.
- Selecciona los siguientes ámbitos.
read:attachment:confluenceread:configuration:confluenceread:content.metadata:confluenceread:content-details:confluenceread:whiteboard:confluenceread:group:confluenceread:space:confluenceread:user:confluencesearch:confluencewrite:page:confluencewrite:attachment:confluence
- Confirma que todos los ámbitos estén seleccionados y guarda los cambios.
Configurar un token de API en Confluence
Si tienes previsto usar un token de API para la autenticación, debes crear un token de API sin ámbitos. Este conector no admite tokens de API con ámbitos.
- Inicia sesión en la consola de Atlassian.
- Haz clic en Crear token de API.
- Introduce un nombre para el token de API.
- Selecciona una fecha de vencimiento para el token de API. El periodo de caducidad del token oscila entre 1 y 365 días.
- Haz clic en Crear.
- Guarda el token para usarlo más adelante.
Gestionar la visibilidad de los usuarios
Para que la dirección de correo del usuario sea visible para cualquier persona de la cuenta de Atlassian, sigue estos pasos:
Inicia sesión en la consola de desarrolladores de Atlassian.
Haz clic en el icono de perfil y selecciona Consola de Google Play.
Haz clic en el icono de perfil de usuario y selecciona Gestionar cuenta.
Ve a Perfil y visibilidad.
Ve a Contacto y selecciona Cualquier persona en Quién puede ver esto.
Para que el correo del usuario sea visible para cualquier persona de Confluence, sigue estos pasos:
Inicia sesión en Atlassian con tus credenciales de usuario.
Selecciona una aplicación de Confluence.
Haz clic en Configuración > Sistema.
En el panel de la izquierda, selecciona Configuración general.
Haz clic en Edit Settings (Editar configuración).
En Visibilidad del correo electrónico del usuario, selecciona Público.
Haz clic en Actualizar.
Instalar y configurar User Identity Accessor para Confluence Cloud
Si las direcciones de correo de los usuarios no son accesibles públicamente de forma predeterminada debido a la configuración de privacidad de Confluence Cloud, debes instalar la aplicación User Identity Accessor for Confluence Cloud para recuperar de forma segura las direcciones de correo de los usuarios. Si las direcciones de correo de los usuarios ya son públicas, puede que no tengas que instalar la aplicación. Para obtener más información sobre la visibilidad restringida de los correos, consulta Gestionar la visibilidad de los usuarios y asignar 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 conceder los permisos necesarios a nivel de aplicación.
- Rol necesario: debes tener el rol
Confluence Site administratorpara instalar y configurar la aplicación. - Permisos de las aplicaciones: debes conceder 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 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.
Instalar User Identity Accessor para Confluence Cloud
Para instalar la aplicación User Identity Accessor for Confluence Cloud en tu sitio de Confluence, sigue estos pasos:
- Ve a Atlassian Developer Console.
Revisa los permisos Leer dirección de correo y Permiso de almacenamiento de aplicaciones y haz clic en Obtener aplicación.
En la lista Selecciona un sitio en el que instalar esta aplicación, elige el sitio de Confluence en el que quieras instalar la aplicación. En esta lista solo se muestran los sitios a los que tienes acceso de administrador.
Nota: Para instalar la aplicación, debes ser administrador de al menos un sitio de Confluence.
Haz clic en Instalar para completar la instalación de la aplicación.
Configurar User Identity Accessor para Confluence Cloud
Una vez que hayas instalado 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 aplicación y obtener correos.
Acceder 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:
- En su instancia de Confluence Cloud, haga clic en el icono Configuración ⚙️ del menú de navegación.
- Selecciona Aplicaciones en el menú.
- En la página Administración de aplicaciones, busca tu aplicación User Identity Accessor for Confluence Cloud en la lista Gestionar aplicaciones.
- Haz clic en Configurar o en el enlace asociado a tu aplicación. Se abrirá la página de configuración específica de la aplicación en Confluence.
Configurar la clave de API
Para configurar la clave de API en la página de configuración, sigue estos pasos:
En la sección Configuración de la clave de API, especifica la clave secreta para autenticar las solicitudes al webtrigger de la aplicación. Puedes autenticar las solicitudes con cualquiera de los siguientes métodos:
Introduce tu propia clave: escribe o pega tu propia clave de API única y segura en el campo Clave de API. Usa una clave de al menos 20-30 caracteres con una combinación de letras mayúsculas, 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 segura en el campo.
Importante: Copia inmediatamente 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 de salir de la página. Si la pierdes, tendrás que crear o generar una nueva.
Haz clic en Guardar clave de API. Aparecerá un mensaje de confirmación que indica que la clave se ha guardado de forma segura.
Probar la configuración de la aplicación
Verifica que el User Identity Accessor de la aplicación Confluence Cloud esté configurado correctamente enviando una solicitud desde tu sistema externo y confirmando que las direcciones de correo electrónico de los usuarios se devuelven correctamente.
Obtener la URL del activador web
- En la página Administración de aplicaciones, busca la sección URL de Webtrigger, que muestra la URL única específica de tu sitio de Confluence y de esta instalación de la aplicación:
- Tu sistema externo debe llamar a esta URL para solicitar correos de usuarios.
Por ejemplo,
https://YOUR_INSTANCE_ID.hello.atlassian-dev.net/x1/WEBTRIGGER_ID, dondeYOUR_INSTANCE_IDes el identificador de tu instancia de Confluence Cloud yWEBTRIGGER_IDes el identificador único del endpoint de WebTrigger generado para tu aplicación.
- Tu sistema externo debe llamar a esta URL para solicitar correos de usuarios.
Por ejemplo,
- Haz clic en el botón Copiar URL o copia la URL completa.
Configurar el sistema externo
Configura el sistema externo que necesite obtener las direcciones de correo de los usuarios de Confluence con la clave de API y la URL del activador web que has obtenido en los pasos anteriores.
- URL de endpoint: la URL de activador web que has copiado.
- Método HTTP:
POST Encabezados obligatorios:
- Content-Type:
application/json X-Api-Key:
YOUR_API_KEYSustituye
YOUR_API_KEYpor la clave de API que hayas configurado o generado en la sección Configurar la clave de API.
- Content-Type:
Comando curl de ejemplo
En este ejemplo se muestra cómo llamar al User Identity Accessor for Confluence Cloud (Acceso a la identidad de usuario de Confluence Cloud), que acepta una matriz de IDs de cuenta 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"
]
}'
Sustituye:
YOUR_INSTANCE_IDcon el ID de tu instancia de Confluence CloudENDPOINT_PATHcon la ruta del endpoint de la APIYOUR_API_KEYcon la clave de API que hayas configurado o generado en la sección Configurar la clave de APIACCOUNT_IDcon los IDs de cuenta de Atlassian que quieras segmentar
Respuesta esperada
[{"accountId":"ACCOUNT_ID_1","emailAddress":"EMAIL_ADDRESS_1"},
{"accountId":"ACCOUNT_ID_2","emailAddress":"EMAIL_ADDRESS_2"}]
Sustituye:
ACCOUNT_ID_Xcon IDs de cuenta de Atlassian realesUSER_EMAIL_Xcon direcciones de correo de usuario devueltas por tu llamada a la API
Implementar 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 todas las comunicaciones con la URL del webhook se realicen a través de HTTPS. Este es el valor predeterminado de los webhooks User Identity Accessor for Confluence Cloud.
Compatibilidad con User Identity Accessor para Confluence Cloud
Google ofrece asistencia para la aplicación User Identity Accessor for Confluence Cloud, que puede incluir mantenimiento y actualizaciones periódicas para que la aplicación esté al día. Si tienes algún problema o alguna pregunta específica sobre la funcionalidad de la aplicación, ponte en contacto con el Google Cloud equipo de Asistencia.