En esta página, se describe cómo configurar un parámetro de configuración de terceros antes de crear el almacén de datos de Jira 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 Jira 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 Jira
Para verificar el acceso de administrador de la organización de Jira, haz lo siguiente:
Accede a Atlassian con tus credenciales de usuario.
Selecciona la app de Jira.
Haz clic en Configuración.
Si ves la opción Sistema en Configuración de Jira, tienes acceso de administrador de la organización de Jira. De lo contrario, pídele al administrador de tu organización de Jira que te proporcione acceso.
Crea una app de OAuth 2.0
Para crear una app de OAuth 2.0, haz lo siguiente:
Accede a la Consola para desarrolladores de Atlassian.
Haz clic en el ícono de perfil y selecciona Consola para desarrolladores.
En la página Console, haz clic en Create y selecciona OAuth 2.0 Integration.
En la página de creación de la app, haz lo siguiente:
Ingresa un nombre para la app.
Selecciona la casilla de verificación para aceptar las condiciones para desarrolladores de Atlassian.
Haz clic en Crear.
En la página de la app, haz lo siguiente:
En el menú de navegación, haz clic en Autorización.
En la tabla Tipo de autorización, selecciona Agregar para OAuth 2.0 (3LO).
En el campo URL de devolución de llamada, ingresa
https://vertexaisearch.cloud.google.com/console/oauth/jira_oauth.html.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:
- En la página de la app, haz clic en Distribución en el menú de navegació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.
- Ingresa la información en los siguientes campos obligatorios:
- En Proveedor, ingresa
Google. - En Política de privacidad, ingresa
https://policies.google.com. - En ¿Tu app almacena datos personales?, selecciona Sí.
- Selecciona la casilla de verificación Confirmo que implementé la API de informes de datos personales. Para obtener más información, consulta la API de informes de datos personales.
- En Proveedor, ingresa
- Haz clic en Guardar cambios.
En la página de la app, haz lo siguiente:
- En el menú de navegación, haz clic en Configuración.
- 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
Obtén el ID de instancia:
- Abre una pestaña nueva, copia la URL de la instancia y agrega
/_edge/tenant_infoa esa URL. Por ejemplo,https://YOUR_INSTANCE.atlassian.net/_edge/tenant_info - Navega al vínculo para encontrar el valor de
cloudId. ElcloudIdes el ID de tu instancia.
- Abre una pestaña nueva, copia la URL de la instancia y agrega
Obtén la URL de instancia:
- Ve a atlassian.net y accede con tu cuenta de administrador.
- Selecciona la app que quieras sincronizar. Por ejemplo, sincroniza la primera app.
- Busca la URL de la instancia (el subdominio en la barra de direcciones).
Otorga roles de administrador
Para otorgar al administrador de Jira el rol de editor de Discovery Engine en la consola de Google Cloud , haz lo siguiente:
- En la consola de Google Cloud , ve a la página Gemini Enterprise.
Navega a IAM.
Busca la cuenta de usuario que tiene acceso de administrador en Jira y haz clic en el ícono para editar .
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:
Accede a Atlassian con una cuenta de administrador de la organización.
Haz clic en el ícono de menú y selecciona tu organización. También puedes ir a admin.atlassian.com.
En la página Administrador, haz clic en el producto y selecciona el botón Administrar usuarios.
Administrar usuarios Haz clic en Grupos en Administración de usuarios.
En la página Grupos, haz lo siguiente:
- Haz clic en Crear grupo.
- Ingresa un nombre para el grupo.
Crear 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.
En la página del grupo, haz clic en Agregar producto.
Selecciona Administrador de acceso de usuarios como el rol para Jira.
Selecciona Administrador de productos como el rol para Administración de Jira.
Administrador de acceso de usuario de Jira Haz clic en Otorgar acceso.
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.
Cómo agregar miembros a un grupo
Administra la visibilidad de los usuarios
Para que el correo electrónico del usuario sea visible para cualquier persona de la cuenta de Atlassian, haz lo siguiente:
Accede a la Consola para desarrolladores de Atlassian.
Haz clic en el ícono de perfil y selecciona Consola para desarrolladores.
Haz clic en el ícono de perfil del usuario y selecciona Administrar cuenta.
Administrar cuenta Navega a Perfil y visibilidad.
Perfil y visibilidad Ve a Contacto y establece Quién puede ver esto como Cualquiera.
Contacto
Para que el correo electrónico del usuario sea visible para cualquier persona en Jira, haz lo siguiente:
Accede a Atlassian con tus credenciales de usuario.
Selecciona una app de Jira.
Haz clic en Configuración > Sistema.
Selecciona Configuración general en el panel izquierdo.
Haga clic en Edit Settings.
En Visibilidad del correo electrónico del usuario, selecciona Público.
Selecciona la visibilidad del correo electrónico Haz clic en Actualizar.
Configura los permisos mínimos de la aplicación
Para realizar las acciones definidas, debes configurar los siguientes permisos para el conector de Jira Cloud en la plataforma de Atlassian.
En la página de la aplicación, haz clic en Permisos.
Ve a API de Jira y haz clic en Agregar.
Haz clic en Configurar.
Ve a la pestaña Permisos clásicos.
Haz clic en Editar permisos y selecciona los permisos clásicos según tus requisitos en la siguiente tabla:
| Modo de conexión | Permiso | Objetivo |
|---|---|---|
| Búsqueda y acciones federadas | read:jira-user, read:jira-work |
Se requiere para recuperar y mostrar los resultados de la búsqueda y los detalles del usuario en tiempo real. |
write:jira-work |
Permite que el asistente modifique elementos de trabajo (p.ej., actualizar campos de problemas) y administre comentarios o problemas. | |
| Solo búsqueda federada | read:jira-user, read:jira-work |
Se requiere para buscar y ver problemas, proyectos y perfiles de usuario. |
| Transferencia y acciones de datos | read:jira-work |
Se requiere para el rastreo y la indexación amplios de datos de elementos de trabajo. |
write:jira-work |
Es necesario para realizar acciones de escritura (creación, actualizaciones, comentarios) en elementos de trabajo dentro del entorno transferido. | |
| Transferencia de datos | read:jira-work |
Se requiere para rastrear e indexar el contenido de Jira para la disponibilidad de la búsqueda. |
Confirma que todos los permisos estén seleccionados y haz clic en Guardar.
Ve a la pestaña Permisos detallados.
Haz clic en Editar permisos y selecciona los permisos detallados según tus requisitos en la siguiente tabla:
| Modo de conexión | Permiso | Objetivo |
|---|---|---|
| Búsqueda y acciones federadas | write:comment:jira |
Permite que el asistente publique comentarios o respuestas nuevos directamente desde la interfaz de búsqueda. |
write:issue:jira |
Es necesario para crear problemas nuevos o realizar ediciones importantes en los existentes. | |
| Transferencia y acciones de datos | read:user:jira, read:group:jira, read:avatar:jira |
Se requiere para sincronizar los metadatos de usuarios o grupos y mostrar los perfiles de usuario. |
read:issue-security-level:jira, read:issue-security-scheme:jira |
Es fundamental para el control de acceso y garantiza que los datos transferidos respeten los límites de seguridad de Jira. | |
read:audit-log:jira |
Se usa para hacer un seguimiento de los cambios y realizar sincronizaciones incrementales para mantener actualizados los datos ingeridos. | |
write:comment:jira |
Se requiere para agregar comentarios a los problemas con el asistente. | |
write:issue:jira |
Permite crear o modificar problemas. | |
| Transferencia de datos | read:user:jira, read:group:jira, read:avatar:jira |
Se requiere para rastrear e indexar el contenido de Jira y las relaciones entre usuarios. |
read:issue-security-level:jira, read:issue-security-scheme:jira |
Se requiere para asignar permisos, de modo que solo los usuarios autorizados puedan buscar los datos ingeridos. | |
read:audit-log:jira |
Es necesario para que el motor de sincronización identifique qué elementos se actualizaron o borraron. |
- Confirma que todos los permisos estén seleccionados y haz clic en Guardar.
Instala User Identity Accessor
Para instalar la aplicación User Identity Accessor for Jira Cloud en tu sitio de Jira Cloud, sigue estos pasos:
- Navega a la Consola para desarrolladores de Atlassian.
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.
Revisa los permisos y obtén la app En la lista Selecciona un sitio en el que instalar esta app, elige el sitio de Jira en el que deseas instalar la app. En esta lista, solo se muestran los sitios a los que tienes acceso de administrador.
Haz clic en Instalar para completar la instalación de la app.
Configura User Identity Accessor
Después de instalar la app de User Identity Accessor for Jira Cloud, configura una clave de API que tu sistema externo (por ejemplo, tu conector de Jira Cloud) 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 app de User Identity Accessor for Jira Cloud, haz lo siguiente:
- En tu instancia de Jira Cloud, haz clic en el ícono de Configuración ⚙️ en el menú de navegación.
- Selecciona Apps en el menú.
- En la página Administración de apps, busca tu app, User Identity Accessor for Jira Cloud, en la lista Administra las apps.
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 Jira Cloud.
Configura la app de User Identity Accessor for Jira Cloud
Configura la clave de API
Para configurar la clave de API en la página de configuración, haz lo siguiente:
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.
Ingresa tu propia clave 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.
Genera una clave 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.
Haz clic en Guardar clave de API. Un mensaje de éxito confirmará que la clave se guardó de forma segura.
Prueba la configuración de la app
Verifica si la aplicación User Identity Accessor for Jira 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
- En la página Administración de apps, busca la sección URL del activador web, en la que se muestra la URL única específica de tu sitio de Jira y de la instalación de esta app:
- Tu sistema externo debe llamar a esta URL para solicitar correos electrónicos de los usuarios.
- Ejemplo de URL:
https://YOUR_INSTANCE_ID.hello.atlassian-dev.net/x1/WEBTRIGGER_ID, en el queYOUR_INSTANCE_IDes el identificador de tu instancia de Jira Cloud yWEBTRIGGER_IDes el identificador único del extremo del activador web generado para tu app.
- 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 Jira con la clave de API y la URL del activador web que obtuviste en los pasos anteriores.
URL del extremo: Es la URL del activador web que copiaste.
Método HTTP:
POSTEncabezados obligatorios:
- Content-Type:
application/json X-Api-Key:
YOUR_API_KEYReemplaza
YOUR_API_KEYpor la clave de API que configuraste o generaste en la sección Configura la clave de API.
- Content-Type:
Ejemplo del comando curl
En este ejemplo, se muestra cómo llamar al activador web de User Identity Accessor for Jira 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_IDpor el ID de tu instancia de Jira CloudENDPOINT_PATHpor la ruta de acceso del extremo de APIYOUR_API_KEYpor la clave de API que configuraste o generaste en la sección Configura la clave de APIACCOUNT_IDcon 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_Xcon IDs de cuentas de Atlassian realesUSER_EMAIL_Xcon 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 Jira 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 Jira Cloud.
Compatibilidad con User Identity Accessor for Jira Cloud
Google ofrece servicios de asistencia para la aplicación User Identity Accessor for Jira Cloud que pueden 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 . Si deseas obtener más información, consulta Obtén atención al cliente de Cloud.