Exemple : API REST Credentials pour l'authentification basée sur OAuth 2.0

Cet exemple montre comment utiliser l'API REST Credentials des opérations cloud pour gérer les données d'identification client pour l'authentification basée sur OAuth 2.0 des applications client.

Avant de commencer
  • Autorisation : L'appelant de l'API doit avoir le rôle Administrateur de compte.
  • Tous les appels à l'API nécessitent un jeton de demande de falsification de site croisée (CSRF) valide dans l'en-tête IBM® -CSRF-TOKEN de l'appel. Obtenez un jeton CSRF via POST /instance/services/csrf_token. Pour plus d'informations, voir Prévention de la falsification de requêtes entre sites (CSRF).
Extraction d'une liste des données d'identification client OAuth 2.0
Utilisez l'appel suivant pour afficher une liste des données d'identification client pour l'abonnement :
GET /instance/services/credentials/oauth_clients
Une liste de données d'identification client est renvoyée. Chaque entrée inclut l'ID client, le créateur des données d'identification, l'heure de création et la description. Pour ajouter la pagination à l'appel, utilisez les paramètres de décalage et de taille :
GET /instance/services/credentials/oauth_clients?offset=11&size=10
Création d'un ensemble de données d'identification client OAuth 2.0
Les données d'identification client sont composées d'un ID client et d'un secret client. L'ID client est généré à partir d'un préfixe spécifié dans l'objet JSON du corps de l'appel. Il est recommandé également d'indiquer une description afin de pouvoir facilement identifier ultérieurement le contexte d'utilisation des données d'identification.
Par exemple, si vous souhaitez créer des données d'identification pour une demande de prêt, utilisez l'appel suivant :
POST /instance/services/credentials/oauth_clients
...
{
  "id_prefix": "loanapp"
  "description": "OAuth credentials for loan application."  
}
L'objet renvoyé inclut l'ID client et le secret client générés. Utilisez ces données d'identification avec des données d'identification de service pour le contrôle d'accès de type OAuth de l'environnement de cloud pour votre demande de prêt. Pour plus d'informations, voir Utilisation de l'authentification basée sur OAuth 2.0 pour les applications clientes.
Suppression d'un ensemble de données d'identification client OAuth 2.0
Utilisez l'appel suivant pour supprimer des données d'identification client :
DELETE /instance/services/credentials/{client_id}
L'ID client et le secret client sont supprimés. Si les applications clientes utilisent encore les informations d'identification pour l'authentification basée sur OAuth 2.0, elles ne pourront pas obtenir de nouveaux jetons de rafraîchissement ; le code de réponse HTTP BAD_REQUEST (400) sera renvoyé à la place. Pour plus d'informations, voir l'étape d'actualisation dans l' utilisation de l'authentification OAuth 2.0 pour les applications clientes.