Definición de componentes de esquema de seguridad OAuth2

Un componente de esquema de seguridad OAuth2 define los valores para controlar el acceso a las operaciones de API mediante el estándar de autorización OAuth.

Antes de empezar

Para poder crear un componente de esquema de seguridad OAuth2, debe:

Cree un proveedor de OAuth.
- Para utilizar Gestor de API, consulte Configuración de un proveedor OAuth nativo o Configuración de un proveedor OAuth de terceros.
Añada el proveedor de OAuth a un catálogo. Si no ha creado ningún catálogo, utilice el Catálogo de recinto de pruebas. Consulte el paso de instrucciones de OAuth en Creación y configuración de catálogos.

Acerca de esta tarea

Nota:

Esta tarea está relacionada con la configuración de una definición de API OpenAPI 3.0. Para obtener detalles sobre cómo configurar una definición de API de OpenAPI 2.0 , consulte Edición de una definición de API de OpenAPI 2.0.
Las API de OpenAPI 3.0 solo están soportadas con DataPower® API Gateway, no con DataPower Gateway (v5 compatible).
Para obtener detalles sobre las limitaciones actuales del soporte de OpenAPI 3.0 , consulte el soporte de OpenAPI 3.0 en IBM® API Connect.

Puede completar esta tarea utilizando la aplicación de interfaz de usuario de API Designer o utilizando la interfaz de usuario de API Manager basada en navegador.

Para utilizar un componente de esquema de seguridad OAuth2, debe hacer referencia a él desde otra ubicación de la definición de API. Para obtener más información, consulte Imposición de requisitos de seguridad en una API y Imposición de requisitos de seguridad en una operación.

En cualquier momento, puede conmutar directamente al origen YAML OpenAPI subyacente pulsando el icono Origen Icono OpenAPI Source . Para volver al formulario de diseño, pulse el icono Formulario Icono de formulario .

Procedimiento

Abra la API para editarla, tal como se describe en Edición de una definición de API de OpenAPI 3.0.
Expanda Componentes y, a continuación, si ya hay uno o varios componentes de esquema de seguridad definidos, expanda Esquemas de seguridad.
Para crear un componente de esquema de seguridad OAuth2 , pulse el icono Añadir junto a Esquemas de seguridad. Para editar un componente de esquema de seguridad OAuth2 existente, pulse el nombre del componente en el panel de navegación.
Si está creando un componente de esquema de seguridad OAuth2, puede crearlo desde cero o hacer referencia a otro componente de esquema de seguridad OAuth2.
Para crear un componente de esquema de seguridad OAuth2 desde cero, especifique la información siguiente en la pestaña Definición:
- Nombre de esquema de seguridad: una clave que permite hacer referencia a este componente de esquema de seguridad OAuth2 desde otra ubicación de la definición de API; la referencia tiene el formato siguiente:
```
#/components/securitySchemes/Security_Scheme_Name
```
- Tipo de definición de seguridad: Seleccione oauth2.
- Flujo: seleccione una o varias de las opciones siguientes:
  - implicit
  - Propietario de recursos - Contraseña
  - Aplicación
  - Código de acceso
  Nota: Las opciones de flujo disponibles para la selección dependen de las opciones soportadas por el proveedor OAuth seleccionado.
  Si ha seleccionado Propietario de recurso-JWT como tipo de otorgamiento soportado al crear el proveedor OAuth, debe seleccionar Propietario de recurso-Contraseña como Flujo para este esquema de seguridad.
- Proveedor de OAuth: nombre del proveedor de OAuth que debe utilizarse. Este es el valor del campo name generado automáticamente al crear el proveedor de OAuth.
- Descripción: descripción opcional del esquema de seguridad OAuth2. Puede utilizar la sintaxis CommonMark para la representación de texto enriquecido.
Para hacer referencia a otro componente de esquema de seguridad OAuth2, especifique la información siguiente en la pestaña Referencia:
- Nombre de esquema de seguridad: una clave que permite hacer referencia a este componente de esquema de seguridad OAuth2 desde otra ubicación de la definición de API; la referencia tiene el formato siguiente:
```
#/components/securitySchemes/Security_Scheme_Name
```
- Referencia desde: seleccione una referencia a otro componente de esquema de seguridad OAuth2.
Si está editando un componente de esquema de seguridad OAuth2 existente, especifique la información siguiente:
- Los puntos finales de URL (los puntos finales aplicables dependen del tipo de flujo):
  - URL de autorización
  - URL de renovación
  - URL de señal
  Nota: Los valores de punto final de URL suministrados aquí se mantienen sólo con fines informativos, API Connect no les aplica ninguna validación ni ninguna otra acción. La seguridad de OAuth que se aplica depende del proveedor de OAuth especificado.
- Ámbitos:
  - Para añadir un nuevo ámbito, pulse Añadir. Para editar un ámbito existente, pulse el icono de opciones junto al ámbito necesario y, a continuación, pulse Editar.
  - Especifique la información siguiente:
    - Ámbito: identificador del ámbito.
    - Descripción: descripción opcional del ámbito. Puede utilizar la sintaxis CommonMark para la representación de texto enriquecido.
Si está creando un nuevo componente de esquema de seguridad OAuth2 , pulse Crear.
Se visualizarán los detalles del componente de esquema de seguridad, que pueden editarse.
Haga clic en Guardar cuando haya terminado.

Qué hacer a continuación

Aplique el esquema de seguridad a una API u operación. Para obtener más información, consulte Imposición de requisitos de seguridad en una API y Imposición de requisitos de seguridad en una operación.