Domaines d'identité OCI avec facteur

Pour suivre ce tutoriel, vous devez disposer des éléments suivants :

• Accès à un domaine d'identité doté du rôle d'administrateur de domaine d'identité. Assurez-vous d'avoir les valeurs suivantes :
  • Le nom de la location, le nom du domaine d'identité et les données d'identification (nom d'utilisateur et mot de passe) pour vous connecter à une location de la console Oracle Cloud Infrastructure dotée d'un domaine d'identité.
  • URL du domaine affichée dans la page des détails du domaine d'identité après la connexion. Par exemple, https://<idcs-letterandnumberstring>.identity.oraclecloud.com. Si vous avez besoin d'aide pour trouver l'URL du domaine, voir Recherche d'une URL de domaine d'identité dans la documentation. L'URL du domaine d'identité est utilisée pour créer une demande REST.
• Connaissance du style d'architecture REST
• L'application de bureau Postman est installée.
  • La connaissance du facteur n'est pas nécessaire.
  • Créez un compte Postman. Un compte est requis pour utiliser des variables d'environnement.
  • (Facultatif) Créez un espace de travail dans Postman.

Pour authentifier un appel d'API REST vers un domaine d'identité, enregistrez une application client OAuth dans le domaine d'identité.

Cette tâche est requise pour obtenir les données d'identification (ID client et clé secrète client) utilisées pour l'authentification. Les données d'identification sont équivalentes aux données d'identification de service (ID et mot de passe) que le client utilise pour communiquer avec un domaine d'identité. Cette tâche vous aide également à déterminer quelles demandes sont autorisées au moyen de l'API REST.

1. Ouvrez le menu de navigation et sélectionnez Identité et sécurité. Sous Identité, sélectionnez Domaines.
2. Sélectionnez le nom du domaine d'identité dans lequel vous voulez travailler. Vous devrez peut-être modifier le compartiment pour trouver le domaine souhaité.
3. Dans la page des détails du domaine, sélectionnez Applications intégrées.
4. Sélectionnez Ajouter une application.
5. Dans la boîte de dialogue Ajouter une application, sélectionnez Application confidentielle, puis Lancer le flux de travail.
6. À l'étape Ajouter les détails de l'application du flux de travail, entrez un nom d'application et une description, puis sélectionnez Suivant.
7. À l'étape Configurer OAuth, effectuez les actions suivantes :
   1. Dans la zone Configuration du client, sélectionnez Configurer cette application comme client maintenant.

      La boîte se développe, affichant plus d'options.

   2. Sous Autorisation, sélectionnez uniquement Données d'identification du client comme type d'autorisation autorisé.
   3. Faites défiler vers le bas jusqu'à la fin de la boîte. Sélectionnez Ajouter des rôles d'application, puis Ajouter des rôles.
   4. Dans le panneau Ajouter des rôles d'application, sélectionnez Administrateur de domaine d'identité, puis Ajouter.
8. À l'étape Configurer OAuth, sélectionnez Suivant, puis Terminer.

   Vous pouvez ignorer l'étape de configuration de la politique dans ce tutoriel.

   Lorsque l'application est créée, son état initial est Inactif.

9. Dans la page Détails de l'application, sélectionnez Activer. Sélectionnez ensuite Activer l'application pour confirmer l'activation de cette application.
10. Dans la page des détails de l'application, faites défiler l'affichage vers le bas jusqu'à Informations générales et suivez ces étapes pour copier l'ID client et les valeurs de clé secrète client.
    1. Mettez en surbrillance la valeur affichée à côté de ID client et copiez-la dans un fichier texte.
    2. Sous Clé secrète client, sélectionnez Afficher la clé secrète. Dans la boîte de dialogue qui s'affiche, sélectionnez Copier, puis Fermer. La valeur est copiée dans le presse-papiers. Collez la valeur dans un fichier texte.
    3. Stockez les valeurs d'ID client et de clé secrète client que vous avez copiées dans un emplacement sécurisé.

Pour exécuter ce tutoriel avec succès dans Postman, importez les exemples de variable REST idcs-rest-clients et définissez les paramètres d'environnement.

1. Ouvrez l'application de bureau Postman et connectez-vous à l'aide de votre compte. Si vous avez un espace de travail, sélectionnez Espace de travail et sélectionnez-le. Sinon, vous pouvez utiliser l'espace de travail par défaut.
2. Dans l'espace de travail, sélectionnez Importer.
3. Dans la boîte de dialogue Importer, collez l'URL suivante des variables d'environnement GitHub dans le champ.

   https://github.com/oracle/idm-samples/raw/master/idcs-rest-clients/example_environment.json

   Postman commence l'importation dès que vous collez l'URL. Une fois l'importation terminée, sélectionnez Omettre pour fermer la boîte de message.

4. Dans la barre latérale de gauche, sélectionnez Environnement. Cliquez ensuite avec le bouton droit de la souris sur Exemple d'environnement Oracle Identity Cloud Service avec variables et sélectionnez Dupliquer.
5. Dans la liste des environnements, cliquez avec le bouton droit de la souris sur Exemple d'environnement Oracle Identity Cloud Service avec copie de variables qui s'affiche sous l'environnement initial et sélectionnez Renommer. Dans le champ, entrez Environment A for REST API Testing et appuyez sur Entrée.
6. Pour mettre à jour les variables dans l'environnement renommé, entrez les valeurs suivantes dans les champs Valeur initiale et Valeur courante.
   • HOST : URL de domaine que vous avez obtenue à partir de la page des détails du domaine d'identité après vous être connecté à la console Oracle Cloud Infrastructure. Par exemple, https://<idcs-letterandnumber123string>.identity.oraclecloud.com. Si vous avez besoin d'aide pour trouver l'URL du domaine, voir Recherche d'une URL de domaine d'identité dans la documentation.
   • CLIENT_ID et CLIENT_SECRET : ID client et clé secrète client que vous avez copiés dans un fichier texte à partir de l'application approuvée du domaine d'identité, comme décrit dans la tâche de tutoriel Enregistrer une application client.
   • USER_LOGIN et USER_PW : Votre nom d'utilisateur et votre mot de passe de connexion
     
     
     
     
7. Sélectionnez Enregistrer.
8. Dans la liste des environnements, cochez la case Environment A for REST API Testing pour en faire l'environnement actif.

   L'environnement actif est affiché dans le sélecteur d'environnement dans le coin supérieur droit de l'atelier.

Pour exécuter ce tutoriel avec succès dans Postman, importez la collection REST_API_for_Oracle_Identity_Cloud_Service, qui contient des exemples de demandes d'API pouvant être utilisées pour effectuer des appels.

1. Dans l'espace de travail Postman, sélectionnez Importer.
2. Dans la boîte de dialogue Importer, collez l'URL suivante dans le champ pour importer la collection Postman d'API REST des domaines d'identité.

   https://github.com/oracle/idm-samples/raw/master/idcs-rest-clients/REST_API_for_Oracle_Identity_Cloud_Service.postman_collection.json

   Postman commence à importer dès que vous collez l'URL. Une fois l'importation terminée, vous pouvez sélectionner Omettre pour fermer la boîte de message.

3. Dans la barre latérale de gauche, sélectionnez Collections (Collections).
4. Sélectionnez le nom REST_API_for_Oracle_Identity_Cloud_Service.

   Les demandes de la collection sont organisées dans des dossiers.

   
   
   
   
   

Pour effectuer des appels d'API à un domaine d'identité, vous devez authentifier le client par rapport au domaine d'identité, puis obtenir un jeton d'accès OAuth.

Le jeton d'accès fournit une session entre un client (dans ce tutoriel, Postman) et le domaine d'identité.

1. Dans la barre latérale de gauche, sélectionnez Collections (Collections). Développez REST_API_for_Oracle_Identity_Cloud_Service, s'il n'est pas développé.
2. Développez OAuth, puis Jetons.
3. Sous Jetons, sélectionnez POST Obtenir access_token (données d'identification du client).

   L'onglet POST de l'API s'affiche dans l'atelier. Le volet de demande de l'API est séparé du volet de réponse par une ligne. Vous pouvez faire glisser la ligne de séparation pour afficher plus ou moins de chaque volet.

   Dans le volet de demande, le champ URL affiche : POST {{HOST}}/oauth2/v1/token

   Les variables pour {{HOST}}, la connexion et les données d'identification d'authentification sont déjà définies lorsque vous avez terminé la tâche de tutoriel Définir les paramètres d'environnement dans Postman.

4. Sélectionnez envoyer.

   Dans le visualiseur de réponse, vérifiez que le statut 200 OK apparaît et que le jeton d'accès est retourné dans le corps de la réponse. Un jeton d'accès est une très longue chaîne de lettres et de chiffres.

5. Pour affecter la valeur du jeton d'accès à une variable d'environnement, procédez comme suit.
   1. Dans la réponse, mettez en surbrillance le contenu du jeton d'accès qui se trouve entre les guillemets et cliquez avec le bouton droit de la souris. Dans le menu contextuel, sélectionnez Définir : Environnement A pour le test d'API REST, puis sélectionnez access_token dans le menu secondaire pour affecter le contenu mis en surbrillance en tant que valeur d'environnement du jeton d'accès.
      
      
      
      
   2. Dans le coin supérieur droit de l'atelier, sélectionnez l'icône pour ouvrir le volet des variables.

      La valeur access_token affectée est affichée sous Toutes les variables.

      
      
      
      
      
6. Pour fermer le volet des variables, sélectionnez X dans le coin supérieur droit du volet ou sélectionnez l'icône des variables.

Si vous envoyez le prochain appel d'API REST au domaine d'identité avant l'expiration du jeton, l'appel d'API contient le jeton d'accès et d'autres informations relatives à la demande. Les informations REST sont envoyées au moyen d'un identificateur de ressource universel de demande, d'un en-tête, de paramètres ou d'un code JSON et varient en fonction de l'appel et de la méthode d'API REST que vous demandez.

Cette tâche suppose que vous avez demandé un jeton d'accès au cours de la dernière heure.

Si nécessaire, demandez un nouveau jeton avant de créer un utilisateur.

1. Dans la barre latérale de gauche, sélectionnez Collections (Collections). Développez Utilisateurs, puis Créer.
2. Sous Créer, sélectionnez Créer un utilisateur.

   L'onglet POST de l'API s'affiche dans l'atelier.

3. Sélectionnez l'onglet Corps.

   L'exemple utilise le mode brut et le format JSON pour les données de corps.

   
   
   
   
   
4. Sélectionnez envoyer.

   • Dans le visualiseur de réponse, vérifiez que le statut 201 Created apparaît et que le corps de la réponse contient des détails sur l'utilisateur qui a été créé avec succès dans le domaine d'identité.

   • Si le statut 401 Unauthorized s'affiche, avec le message d'erreur Proper authorization is required for this area, demandez un nouveau jeton d'accès et réessayez de créer l'utilisateur.

5. Dans le corps de la réponse d'une création réussie, faites défiler l'affichage vers le bas jusqu'à la ligne 40, qui a la valeur OCID de l'utilisateur créé.

   Par exemple : ocid1.user.oc1..aabaaacaaaq7xxxxxx

6. Mettez en surbrillance la valeur de l'OCID entre guillemets. Dans le menu contextuel, sélectionnez Définir : Environnement A pour le test d'API REST, puis sélectionnez ID utilisateur dans le menu secondaire.
7. Dans le coin supérieur droit de l'atelier, sélectionnez l'icône pour ouvrir le volet des variables.

   La valeur userid affectée est affichée sous Toutes les variables.

Cette tâche extrait les détails d'un utilisateur spécifique à l'aide de la variable userid.

La procédure suivante suppose que vous avez terminé la tâche précédente Créer un utilisateur.

1. Dans la barre latérale de gauche, sélectionnez Collections (Collections). Développez Utilisateurs, puis Rechercher.
2. Sous Rechercher, sélectionnez Obtenir un utilisateur spécifique.

   L'onglet GET de l'API s'affiche dans l'atelier.

3. Sélectionnez envoyer.

   • Si vous réussissez, confirmez que le statut 200 OK apparaît dans le visualiseur de réponse. Vous devez également voir les détails de cet utilisateur spécifique dans l'onglet Corps.

   • Si vous voyez le statut 401 Unauthorized avec le message d'erreur Proper authorization is required for this area, demandez un nouveau jeton d'accès et réessayez d'extraire l'utilisateur spécifique.

Cette tâche supprime un utilisateur spécifié par la variable userid.

La procédure suivante suppose que vous avez terminé les tâches de tutoriel Créer un utilisateur et Obtenir un utilisateur.

Si nécessaire, demandez un nouveau jeton d'accès avant d'effectuer cette tâche.

1. Dans la barre latérale de gauche, sélectionnez Collections (Collections). Développez Utilisateurs, puis Supprimer.
2. Sélectionnez Supprimer l'utilisateur.

   L'onglet DELETE de l'API s'affiche dans l'atelier.

3. Dans le coin supérieur droit de l'atelier, sélectionnez l'icône pour ouvrir le volet des variables.

   Sous Toutes les variables, vérifiez que la variable userid affiche toujours la même valeur d'OCID que celle utilisée pour extraire les détails de l'utilisateur.

4. Sélectionnez envoyer.

   • Si vous réussissez, confirmez que le statut 204 No content apparaît dans le visualiseur de réponse. L'onglet Corps est vide, car aucun corps de réponse n'est retourné pour une opération DELETE.

   • Si vous voyez le statut 401 Unauthorized avec le message d'erreur Proper authorization is required for this area, demandez un nouveau jeton d'accès et réessayez de supprimer l'utilisateur spécifique.

5. Lorsque la suppression est réussie, sélectionnez l'onglet Obtenir un utilisateur spécifique dans l'atelier. Sélectionnez ensuite Envoyer.

   Dans le visualiseur de réponse, vérifiez que le statut 404 Not found apparaît, ce qui indique que l'utilisateur a été supprimé.

Pour explorer des directives pour créer des demandes et des cas d'utilisation courants à l'aide des API REST des domaines d'identité OCI, voir :

• Structuration des demandes de ressources
• Cas d'utilisation d'API