Ejemplo: API REST de Credentials para la autenticación basada en OAuth 2.0

En este ejemplo se muestra cómo utilizar la API REST de Credentials de operaciones de nube para gestionar credenciales de cliente para la autenticación basada en OAuth 2.0 de aplicaciones cliente.

Antes de empezar
  • Autorización: el emisor de llamada de la API debe tener el rol Administrador de cuentas.
  • Todas las llamadas a la API requieren un token válido de solicitud de falsificación de sitios cruzados (CSRF) en la cabecera IBM® -CSRF-TOKEN de la llamada. Obtenga una señal CSRF mediante POST /instance/services/csrf_token. Para obtener más información, consulte Cómo evitar la falsificación de solicitudes entre sitios.
Recuperar una lista de credenciales de cliente de OAuth 2.0
Utilice la llamada siguiente para visualizar una lista de credenciales de cliente para la suscripción:
GET /instance/services/credentials/oauth_clients
Se devuelve una lista de credenciales de cliente. Cada entrada incluye el ID de cliente, el creador de las credenciales, la hora de creación y la descripción. Para añadir la paginación a la llamada, utilice los parámetros offset y size:
GET /instance/services/credentials/oauth_clients?offset=11&size=10
Crear un conjunto de credenciales de cliente de OAuth 2.0
Las credenciales de cliente constan de un ID de cliente y un secreto de cliente. El ID de cliente se genera a partir de un prefijo que especifica en el objeto JSON del cuerpo de la llamada. Es recomendable especificar también una descripción para que pueda identificar fácilmente para qué se utilizan las credenciales.
Por ejemplo, si desea crear credenciales para una aplicación de préstamos, utilice la llamada siguiente:
POST /instance/services/credentials/oauth_clients
...
{
  "id_prefix": "loanapp"
  "description": "OAuth credentials for loan application."  
}
El objeto devuelto incluye el ID de cliente y el secreto de cliente generados. Utilice estas credenciales conjuntamente con las credenciales de servicio para el control de acceso basado en OAuth al entorno de nube para la aplicación de préstamo. Para obtener más información, consulte Uso de la autenticación basada en OAuth 2.0 para aplicaciones cliente.
Suprimir un conjunto de credenciales de cliente de OAuth 2.0
Utilice la llamada siguiente para suprimir credenciales de cliente:
DELETE /instance/services/credentials/{client_id}
Se suprimen el ID de cliente y el secreto de cliente. Si las aplicaciones de cliente siguen utilizando las credenciales para la autenticación basada en OAuth 2.0, no podrán obtener señales de renovación nuevas y en su lugar se devolverá el código de respuesta HTTP BAD_REQUEST (400). Para obtener más información, consulte el paso de actualización en Uso de la autenticación basada en OAuth 2.0 para aplicaciones cliente.