Página de Perfiles de Seguridad en Jitterbit API Manager

Introducción

Usa la página Perfiles de Seguridad en API Manager para configurar y administrar perfiles de seguridad. Los perfiles de seguridad controlan el acceso de los usuarios a las APIs de API Manager.

Alternativamente, crea y administra perfiles de seguridad usando el Asistente de IA de APIM.

Para realizar acciones o ediciones en la página Perfiles de Seguridad, se requiere un rol con permiso de Admin. Los usuarios en roles que no son de administrador con acceso al entorno de Lectura o superior tienen acceso de solo lectura.

Para obtener información sobre perfiles de seguridad, consulta Perfiles de seguridad en Conceptos clave.

Acceder a la página de Perfiles de Seguridad

Para acceder a la página Perfiles de Seguridad, usa el menú del portal Harmony para seleccionar API Manager > Perfiles de Seguridad.

Encabezado de la página de Perfiles de Seguridad

El encabezado en la parte superior de la página Perfiles de Seguridad incluye un cuadro de búsqueda, filtros y un botón para crear un nuevo perfil de seguridad:

• Filtros: Puedes filtrar perfiles de seguridad por cualquiera de las siguientes opciones:

  

  • Tipo de autenticación: Selecciona los tipos de autenticación para los perfiles de seguridad. Las opciones incluyen OAuth 2.0, Clave de API, Básica o Anónima. Cuando todos los filtros están deseleccionados, aparecen perfiles de seguridad con cualquier tipo de autenticación.

  • Perfil de seguridad predeterminado: Selecciona si deseas mostrar perfiles predeterminados o no predeterminados.

  • Entorno: Selecciona los entornos donde se encuentran los perfiles de seguridad. Cuando todos los filtros están deseleccionados, aparecen perfiles de seguridad para todos los entornos en tu organización (limitado a los entornos a los que puedes acceder).

  • Estado de vencimiento: Selecciona un estado de vencimiento de clave de API (Activa, Próxima a vencer o Vencida) para filtrar perfiles de seguridad que usan el tipo de autenticación de clave de API. Cuando no se selecciona ningún estado, aparecen perfiles de seguridad con cualquier estado de vencimiento.

  • Grupo de IP de confianza: Selecciona los grupos de IP de confianza incluidos en los perfiles de seguridad.

• Búsqueda: Ingresa cualquier parte del nombre de un perfil de seguridad para filtrar perfiles de seguridad por nombre. La búsqueda no distingue entre mayúsculas y minúsculas.

• Filtrar columnas: Haz clic para cambiar la disposición y visibilidad de las columnas. Se abre el panel Columnas:

  

  El panel incluye estos controles:

  • Mostrar todo: Haz visibles todas las columnas.
  • Mover: Arrastra y suelta para cambiar la posición de la columna en relación con las otras.
  • Ocultar: La columna es visible. Haz clic para ocultarla.
  • Mostrar: La columna está oculta. Haz clic para mostrarla.
  • Guardar: Guarda los cambios de columnas.
  • Cancelar: Cierra el panel de columnas sin guardar los cambios.

• Nuevo: Haz clic para seleccionar una de las siguientes opciones:

  • Crear con IA: Abre el Asistente de APIM para crear un perfil de seguridad usando indicaciones en lenguaje natural. Para obtener más información, consulta Usar el Asistente de IA.

    Nota

    Para usar el Asistente de IA de APIM, tu licencia de Harmony debe incluir la opción Asistente de IA de APIM. Contacta a tu Gerente de Éxito del Cliente (CSM) para agregar esta opción a tu licencia.

  • Perfil de Seguridad: Abre el panel de configuración del perfil de seguridad para crear manualmente un nuevo perfil de seguridad.

Configurar un perfil de seguridad

El cajón de configuración del perfil de seguridad está organizado en secciones contraíbles de Perfil, Autenticación, Registro y Dirección IP de confianza. Configura los campos en cada sección como se describe a continuación, luego haz clic en Guardar para guardar y cerrar la configuración o en Cancelar para cerrarla sin guardar.

Perfil

• Nombre del perfil: Ingresa un nombre para identificar el perfil de seguridad. El nombre no debe comenzar ni terminar con un espacio. Se permite un máximo de 50 caracteres.

  Precaución

  Si configuras el perfil de seguridad con OAuth 2.0 y utilizas Microsoft Entra ID o Google como proveedor de identidad OAuth 2.0 (configurado a continuación), el Nombre del perfil no debe contener espacios. Si el Nombre del perfil contiene espacios, obtendrás un error cuando intentes acceder a una API a la que se asigne el perfil de seguridad.

• Entorno: Utiliza el menú desplegable para seleccionar un entorno existente donde se pueda asignar el perfil de seguridad. Puedes escribir cualquier parte del nombre del entorno en el menú para filtrar la lista de entornos. Los resultados del menú se filtran en tiempo real con cada pulsación de tecla. Para obtener más información sobre la relación entre entornos y perfiles de seguridad, consulta Múltiples perfiles de seguridad en Conceptos clave.

• Predeterminado: Selecciona esta opción para hacer que este perfil de seguridad sea el predeterminado para el entorno seleccionado. El perfil de seguridad predeterminado se preseleccionará cuando se cree una nueva API. Solo se puede seleccionar un perfil de seguridad predeterminado en cada entorno. Después de que se haya especificado un perfil de seguridad predeterminado para un entorno, seleccionar un perfil de seguridad diferente como predeterminado reemplazará la selección del perfil de seguridad predeterminado existente. Seleccionar o cambiar el perfil de seguridad predeterminado no afectará el perfil de seguridad asignado a las API existentes.

• Descripción: Ingresa una descripción opcional del perfil de seguridad.

• Límites de velocidad e impactos por minuto: Habilita Límites de velocidad para aplicar un número máximo compartido de impactos de API por minuto que se pueden realizar en todas las API a las que se asigne este perfil de seguridad. Cuando se selecciona esta opción, debes ingresar un número máximo de impactos por minuto.

  Cuando está habilitado, se rechazan las llamadas que superan el máximo establecido. Como tal, las llamadas a las API asignadas a este perfil de seguridad pueden experimentar un mayor número de rechazos. Para obtener más información, consulta Límites de velocidad en Conceptos clave.

Autenticación

Utiliza el menú Tipo de autenticación para seleccionar un tipo de autenticación para el perfil de seguridad. Después de seleccionar el tipo, hay campos adicionales disponibles para configurar. Esta sección describe los campos para cada tipo:

• Anónimo
• Clave de API
• Básico
• OAuth 2.0

Anónimo

Selecciona el tipo de autenticación Anónimo si no se requiere autenticación.

Clave de API

Selecciona el tipo de autenticación Clave de API para utilizar un par de clave y valor de API para acceder a una API asignada a este perfil de seguridad. Cuando se selecciona este tipo, estos campos se utilizan para crear las credenciales requeridas:

• Clave: Ingresa el nombre del encabezado que deseas utilizar, como Authorization o X-API-KEY. Se permite un máximo de 256 caracteres.
• Valor: Se genera automáticamente un valor para usar con el nombre del encabezado Clave. Puedes editar el valor o utilizar el icono de actualización para generar un nuevo valor. Se permite un máximo de 256 caracteres.
• Copiar: Copia el Valor a tu portapapeles.
• Vencimiento de clave de API y Duración del vencimiento (días): Este interruptor está desactivado de forma predeterminada, en cuyo caso el valor de la clave de API nunca vence. Habilita Vencimiento de clave de API para establecer un período de vencimiento para el valor de la clave de API en su lugar. Cuando está habilitado, ingresa el número de días después del cual vence la clave de API en el campo Duración del vencimiento (días). El valor predeterminado es 180.

Antes de que expire una clave de API, Jitterbit envía un correo electrónico de recordatorio a los administradores de tu organización. Una vez que una clave de API ha expirado, las solicitudes de API que utilizan esa clave se rechazan con un error HTTP 401 Unauthorized.

Básica

Selecciona el tipo de autenticación Básica para usar autenticación HTTP básica y acceder a una API asignada a este perfil de seguridad. Cuando se selecciona este tipo, se utilizan estos campos para crear las credenciales requeridas:

• Nombre de usuario: Ingresa un nombre de usuario para crear para acceder a la API. El nombre de usuario distingue entre mayúsculas y minúsculas y no debe contener dos puntos (:) si tienes la intención de usar las credenciales en un encabezado HTTP al llamar a la API.

• Contraseña: Ingresa una contraseña para crear para acceder a la API.

Base64Encode("exampleuser"+":"+"examplepassword")

OAuth 2.0

Selecciona el tipo de autenticación OAuth 2.0 para usar un token de autorización OAuth 2.0 y acceder a una API asignada a este perfil de seguridad. OAuth 2.0 es un estándar abierto para delegación de acceso. Cuando se selecciona este tipo, se utilizan estos campos para crear las credenciales requeridas:

• Proveedor de OAuth: Usa la lista desplegable para seleccionar un proveedor de identidad compatible. Elige uno de Azure AD (Microsoft Entra ID), Google, Okta o Salesforce.

• Flujo de OAuth de 2 etapas: De forma predeterminada, se utiliza OAuth de 3 etapas para todos los proveedores de identidad. Este proceso requiere interacción manual para autenticarse al acceder a una API asignada a este perfil de seguridad. La opción Flujo de OAuth de 2 etapas está disponible solo para Microsoft Entra ID (Microsoft Entra ID) y Okta. Esta opción te permite configurar un alcance y una audiencia para eliminar el paso manual.

  Nota

  Si utilizas una puerta de enlace de API privada, debes usar la versión 10.48 de la puerta de enlace o posterior para que esta opción funcione. Si la puerta de enlace no es la versión 10.48 o posterior, se utiliza OAuth de 3 etapas incluso si se configura OAuth de 2 etapas. Si no utilizas una puerta de enlace de API privada, esta opción no tiene requisitos de versión.

• Dominios autorizados: Ingresa nombres de dominio separados por comas para limitar el acceso a dominios en la lista de permitidos. Deja en blanco para acceso sin restricciones.

• Credenciales del cliente: Agrega pares de credenciales del cliente (un ID de cliente y un secreto de cliente) para el perfil de seguridad de modo que los consumidores puedan autenticarse en la API. Cuando Flujo de OAuth de 2 etapas está habilitado, puedes agregar múltiples credenciales del cliente, permitiendo que consumidores distintos se autentiquen en la misma API usando credenciales únicas. Cuando Flujo de OAuth de 2 etapas está deshabilitado (3 etapas), puedes agregar una única credencial del cliente. Los siguientes controles están disponibles:

  • Buscar: Ingresa cualquier parte del nombre de un consumidor para filtrar la lista de credenciales del cliente.

  • Agregar credencial del cliente: Haz clic para agregar una fila editable a la tabla. Completa estos campos (todos son obligatorios), luego haz clic en la marca de verificación en la columna Acciones para guardar la credencial o en el icono de cerrar para descartarla:

• Nombre del consumidor: Ingresa un nombre para identificar al consumidor que utiliza este par de credenciales.

  -   **ID de cliente:** Ingresa el ID de cliente que obtuviste del proveedor de identidad.
  
  -   **Secreto de cliente:** Ingresa el secreto de cliente que obtuviste del proveedor de identidad. Usa el icono <span class="icon-eye-filled"></span> para revelar el valor.
  
  -   **Estado:** Establece la credencial como **Activa** o **Inactiva**. Solo las credenciales **Activas** pueden utilizarse para autenticarse con la API.
  

  Cada credencial de cliente guardada aparece como una fila en la tabla, mostrando su Nombre del consumidor, ID de cliente, Secreto de cliente y Estado. Pasa el cursor sobre una fila para revelar estas acciones en la columna Acciones:

  • Editar: Haz clic para editar la credencial de cliente en una fila editable.

  • Eliminar: Haz clic para eliminar la credencial de cliente.

  Consulta las instrucciones para obtener el ID de cliente y el secreto de cliente para Microsoft Entra ID, Google, Okta o Salesforce.

• Los campos restantes de OAuth 2.0 (URL de redirección de OAuth, Alcance de OAuth, URL de descubrimiento de OpenID, Audiencia, URL de autorización de OAuth, URL de token de OAuth, URL de información del usuario y Agregar esta URL de redirección a tu cuenta de OAuth) vienen prellenados con valores predeterminados y contienen configuraciones específicas de tu proveedor de identidad. Algunos de estos campos aparecen solo cuando Flujo de OAuth de 2 etapas está habilitado. Configúralos de acuerdo con las instrucciones de tu proveedor de identidad: Microsoft Entra ID (2 etapas, 3 etapas), Google, Okta (2 etapas, 3 etapas) o Salesforce.

• Probar conectividad: Haz clic para verificar la conectividad con el proveedor de identidad usando la configuración proporcionada. El comportamiento resultante depende de si se está utilizando la opción Flujo de OAuth de 2 etapas:

  • OAuth de 2 etapas: Para Microsoft Entra ID y Okta cuando se está utilizando Flujo de OAuth de 2 etapas, la puerta de enlace de API obtiene el token de acceso y la autenticación ocurre automáticamente. Luego se te redirige a API Manager con un mensaje que muestra los resultados de la prueba.

  • OAuth de 3 etapas: Para Google y Salesforce, y para Microsoft Entra ID y Okta cuando Flujo de OAuth de 2 etapas no se está utilizando, una nueva pestaña del navegador muestra la interfaz de inicio de sesión nativa del proveedor de identidad. Después de proporcionar tus credenciales para el proveedor de identidad, se te redirige a API Manager con un mensaje que muestra los resultados de la prueba.

Registro

Selecciona el identificador que se incluirá en los encabezados de solicitud de API para rastrear qué método de autorización se utilizó para acceder a este perfil de seguridad. Este valor aparece en el campo Usuario establecido en en los registros de API para cada solicitud de API, permitiéndote monitorear y auditar diferentes métodos de acceso.

La etiqueta del primer botón de radio corresponde con el Tipo de autenticación configurado para el perfil de seguridad:

• Anónimo: Envía el valor Anónimo.

• Básico: Envía el valor del campo Nombre de usuario (tal como se define en Autenticación básica).

• OAuth: Envía el valor OAuth2.0.

• Clave de API: Envía el valor APIKEY.

Cuando se selecciona Personalizado para Registro, este campo se vuelve disponible:

• Campo de encabezado de solicitud: Envía el valor ingresado en el cuadro de texto, por ejemplo, X-API-Key.

Dirección IP de confianza

Se puede seleccionar si se desea limitar el acceso a las API dentro del perfil de seguridad a consumidores desde una única dirección IP o un rango de direcciones IP:

• Confiar solo en solicitudes de los siguientes rangos de IP: Habilitar para limitar el acceso a las API dentro de un perfil de seguridad a consumidores desde ciertas direcciones IP. Solo las direcciones IP incluidas dentro de los rangos especificados pueden acceder a las API usando este perfil de seguridad. Cuando se habilita, aparece una tabla de grupos de IP de confianza existentes:

  

  • Búsqueda: Ingresar el nombre de un grupo de IP de confianza existente. Al hacer clic en el cuadro de búsqueda, se completa una lista de grupos de IP de confianza existentes. La lista se filtra en tiempo real con cada pulsación de tecla dentro del cuadro de búsqueda. Hacer clic en el nombre del grupo de IP de confianza para agregarlo al perfil de seguridad.

  • Asignar: Habilitar para asignar el grupo de IP de confianza al perfil de seguridad.

  • Nombre: El nombre del grupo de IP de confianza.

  • Usado en: Los nombres de los perfiles de seguridad donde se está utilizando actualmente el grupo de IP de confianza.

  • Acciones: Pasar el cursor sobre una fila de grupo de IP de confianza para revelar una acción adicional:

    • Editar: Hacer clic para editar los rangos de IP para la fila del grupo de IP de confianza.

  • Nuevo grupo de IP de confianza: Hacer clic para agregar un nuevo grupo de IP de confianza. Al hacer clic, se muestra esta pantalla de configuración:

    

    • Nombre: Ingresar un nombre para identificar el grupo de IP de confianza. Para grupos de IP de confianza existentes, hacer clic en el nombre de un grupo de IP de confianza para renombrarlo.

    • Nuevo rango: Hacer clic para agregar un rango de direcciones IP.

    • Dirección IP inicial: Ingresar la primera dirección IP a incluir en el rango. Solo se admiten direcciones IP ingresadas en formato IPv4.

    • Dirección IP final: Ingresar la última dirección IP a incluir en el rango. Solo se admiten direcciones IP ingresadas en formato IPv4.

    • Descripción: Ingresar una descripción del rango de direcciones IP (opcional).

    • Acciones: Pasar el cursor sobre un rango de direcciones IP para revelar una acción adicional:

      • Eliminar: Elimina la fila del rango de direcciones IP del perfil de seguridad.

    • Cancelar: Hacer clic para descartar el grupo de IP de confianza y volver a la configuración del perfil de seguridad.

    • Guardar: Hacer clic para guardar el grupo de IP de confianza. Después de que se haya guardado el perfil de seguridad, este grupo de IP de confianza estará disponible para su uso en otros perfiles de seguridad según sea necesario.

Ver perfiles de seguridad existentes

La página Perfiles de seguridad muestra todos los perfiles de seguridad existentes en la organización Harmony seleccionada, agrupados por entorno. Cada columna de la tabla se describe a continuación:

• Nombre del perfil: El nombre del perfil de seguridad. Para alternar el orden de clasificación de cada tabla entre orden alfabético descendente y ascendente, hacer clic en la flecha hacia arriba o hacia abajo.

• Vencimiento: Para perfiles de seguridad que utilizan el tipo de autenticación de clave de API con vencimiento de clave de API habilitado, la fecha en que vence la clave de API, junto con una etiqueta de estado que muestra Vencimiento próximo cuando la clave está dentro de 7 días de su fecha de vencimiento. Esta columna está en blanco para perfiles de seguridad que no tienen habilitado el vencimiento de clave de API.

• Tipo de autenticación: El tipo de autenticación utilizado para autenticarse y acceder a las API asignadas a este perfil de seguridad.

• Descripción: Una descripción del perfil de seguridad, si se proporciona.

• APIs que utilizan: Las APIs a las que se asigna el perfil de seguridad.

• Solicitudes por minuto: El número máximo de solicitudes de API permitidas por minuto usando este perfil, si se configura.

• Entorno: El entorno donde se aplica el perfil de seguridad.

• Clase de entorno: La clase del entorno. Esta información se utiliza solo para fines de informes.

• Predeterminado: El nombre del entorno predeterminado del perfil de seguridad, si se configura.

• Creado: La fecha y hora local del navegador cuando se creó el perfil de seguridad.

• Creado por: La dirección de correo electrónico del usuario que creó el perfil de seguridad.

• Última edición: La fecha y hora local del navegador cuando se modificó por última vez el perfil de seguridad.

• Editado por: La dirección de correo electrónico del usuario que editó más recientemente el perfil de seguridad.

• Grupos de IP confiables: Cualquier grupo de IP confiables asignado al perfil de seguridad. Para obtener más información, consulta Direcciones IP confiables.

• Acciones: Pasa el cursor sobre un perfil de seguridad para revelar estos iconos de acción:

  • Editar: Haz clic para abrir la pantalla de configuración del perfil de seguridad.

  • Eliminar: Haz clic para eliminar permanentemente el perfil de seguridad. Un mensaje te pide que confirmes la eliminación. Si el perfil de seguridad se asigna a cualquier API, primero debes desasignarlo o reemplazarlo antes de eliminarlo.

    Importante

    Después de desasignar un perfil de seguridad de una API, debes guardar y publicar la API para que el cambio surta efecto. Hasta que se publique la API, el perfil de seguridad se considera "en uso" y no se puede eliminar hasta que todas las APIs que lo utilizaban anteriormente se hayan publicado con la configuración actualizada. Esto aplica incluso si la API está en estado de borrador con el perfil desasignado.

  • URL de visualización de OAuth: Cuando se configura un perfil de seguridad OAuth de 2 pasos, haz clic para copiar la URL necesaria para generar un token de OAuth. Para obtener instrucciones, consulta OAuth de 2 pasos de Microsoft Entra ID u OAuth de 2 pasos de Okta.

Próximos pasos

Para obtener más información sobre cómo asignar perfiles de seguridad a una API, consulta estos recursos:

• Pestaña Perfiles de seguridad de API
• APIs personalizadas
• APIs OData
• APIs proxy

Solución de problemas

Para la solución de problemas relacionados, consulta lo siguiente en la guía de solución de problemas de API Manager:

• OAuth de Microsoft Entra ID: El nombre del perfil de seguridad no puede contener espacios

• OAuth de 2 pasos de Microsoft Entra ID: error OAUTH_INVALID_TOKEN_CODE

• Azure AD Graph API ha sido retirada

• Proveedor de identidad de Google o Salesforce: OAuth de 2 pasos no es compatible

• Microsoft Copilot Studio: Autenticación básica no compatible

• Autenticación básica: Nombres de usuario inesperados aparecen en los registros de API cuando se asignan múltiples perfiles de seguridad

• CORS habilitado: Las solicitudes OPTIONS se ejecutan sin autenticación

• Los cambios en el perfil de seguridad tardan varios minutos en surtir efecto

• No se puede eliminar un perfil de seguridad mientras siga asignado a una API publicada