Envoyer les demandes

Suivez ces directives lorsque vous créez des demandes d'envoi à l'aide de l'API REST des domaines d'identité.

Structure de l'URL

Accédez à l'API REST des domaines d'identité au moyen d'une URL, qui comprend le point d'extrémité REST, la ressource à laquelle vous voulez accéder et tous les paramètres d'interrogation que vous voulez inclure dans une demande. Obtenez la structure d'URL complète pour l'API REST des domaines d'identité auprès de votre administrateur Oracle Cloud ou de votre administrateur de domaine d'identité.

Point d'extrémité de base

Le point d'extrémité de base de l'API REST des domaines d'identité est :

https://<domainURL>/

Où : domainURL représente l'URL propre au domaine. Pour obtenir cette URL à l'aide de la console des domaines d'identité, voir Recherche d'une URL de domaine d'identité.

Vous pouvez également obtenir cette URL auprès de votre administrateur Oracle Cloud ou de votre administrateur de domaine d'identité.

Points d'extrémité de ressource

Lorsque vous créez une ressource ou que vous effectuez une recherche de membres d'un type de ressource, vous ajoutez le nom de la ressource. Par exemple, lorsque vous envoyez une demande POST pour créer un nouvel utilisateur, vous utilisez le point d'extrémité :

https://<domainURL>/admin/v1/Users

Ressources spécifiques dans un point d'extrémité

Pour accéder à une ressource spécifique, vous ajoutez la valeur de l'attribut id pour cette ressource au point d'extrémité de la ressource. Par exemple, si vous avez créé un utilisateur et que la réponse à votre demande POST comprenait la valeur ocid ocid1.user.oc1..xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx dans le corps de la réponse, vous utilisez le point d'extrémité suivant pour accéder à cette ressource d'utilisateur spécifique dans les demandes GET, PATCH ou PUT suivantes :

https://<domainURL>/admin/v1/Users/ocid1.user.oc1..xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Méthodes prises en charge

L'API REST des domaines d'identité prend en charge les méthodes de demande suivantes.
Note

Les méthodes prises en charge dépendent du point d'extrémité.
Méthode HTTP Description
GET Recherchez des ressources ou recherchez une ressource spécifique par ID.
HEAD Vérifier l'existence ou la modification d'une ressource. Ne renvoie pas de corps de réponse. Lecture seule.
POST Créer, modifier, réinitialiser, importer, authentifier, programmer ou créer une demande de recherche pour les ressources du domaine d'identité.
PUT Remplacer (mettre à jour entièrement) une ressource de domaine d'identité existante, activer ou désactiver une ressource de domaine d'identité, etc.
PATCH Modifier (mettre à jour partiellement) les ressources du domaine d'identité.
DELETE Supprimer ou annuler des ressources de domaine d'identité.
OPTIONS Extraire les opérations autorisées pour le point d'extrémité.

En-têtes pris en charge

L'API REST des domaines d'identité prend en charge les en-têtes suivants qui peuvent être transmis dans la section d'en-tête de la demande ou de la réponse HTTP.

En-tête Description Exemple
Content-Type Type de média du corps de la demande. Obligatoire pour les demandes POST et PUT. Content-Type: application/scim+json Content-Type: application/json
Authorization

Jeton d'accès OAuth utilisé pour accéder aux ressources protégées

Ou les signatures de demande dans l'en-tête d'autorisation

Les jetons d'accès sont de très longues chaînes. Cet exemple a été tronqué : Bearer VkdVAZrb_fw......eyJ4NXQjUzI1Ni