Utilisation de cURL
cURL est un outil de ligne de commande à code source libre pour le transfert de données avec une syntaxe d'URL, prenant en charge divers protocoles, y compris HTTP et HTTPS. Les exemples dans ce document utilisent cURL pour démontrer comment accéder à l'API REST des domaines d'identité.
Utilisation de cURL pour accéder aux API REST
-
Installez cURL. Voir Étape 2 : Installer cURL.
-
Dans une fenêtre de commande, réglez la variable d'environnement cURL,
CURL_CA_BUNDLE
, à l'emplacement de votre ensemble de certificats d'autorité de certification local. Pour plus d'informations sur la vérification du certificat de l'autorité de certification à l'aide de cURL, voir : http://curl.haxx.se/docs/sslcerts.html.Note
Voir Autorisation pour plus d'informations sur les exigences d'autorisation et d'authentification.
-
Appelez cURL et spécifiez une ou plusieurs des options de ligne de commande suivantes, au besoin, pour diriger son exécution.
-d, --data @file.json
: Identifie le document de demande, au format JSON, sur l'ordinateur local.-F, --form @file.json
: Identifie les données de formulaire, au format JSON, sur l'ordinateur local.-H, --header
: Définit l'en-tête de la demande dans le format HEADER : VALUE. Les valeurs d'en-tête dépendent du point d'extrémité auquel vous accédez.-
Type de contenu du document de la demande.
-
X-Client-ID,
API_KEY_ID,
pour l'autorisation OAuth 2.0 -
Autorisation
X-Client-Secret,
API_KEY_SECRET,
pour OAuth2.0
-
-i
: Affiche les informations d'en-tête de réponse.-X
: Indique la méthode de demande HTTP(DELETE, GET, POST, PATCH
ouPUT).
Si cette option est omise, la valeur par défaut est GET.
URL de la commande cURL
L'URL utilisée avec la commande cURL est la même que celle décrite dans Envoyer des demandes, sauf que vous devez remplacer les espaces dans l'URL par des caractères plus (+) et remplacer les guillemets (") par %22.
Tous les caractères d'une URL qui sont en dehors du jeu de caractères ASCII, tels que les espaces et les guillemets, doivent être encodés en tant qu'URL. Par exemple, l'URL suivante contient une interrogation de filtre qui recherche un utilisateur avec un nom d'utilisateur contenant jen
ou commençant par bj
. Notez qu'il contient des espaces.
https://<domainURL>/admin/v1/Users?filter=userName co "jen" or userName sw "bj"
Pour utiliser cette URL dans une ligne de commande cURL, vous devez la remplacer par :
https://<domainURL>/admin/v1/Users?filter=userName+co+%22jen%22+or+userName+sw+%22bj%22
Commande cURL pour l'envoi d'une demande GET
curl
-H "Accept: application/scim+json"
-H "Authorization: Bearer <really long access token here>"
-G https://<domainURL>/admin/v1/Groups?filter=displayName+co+%22admin%22"
Commande cURL pour envoyer une demande POST
curl
-H "Content-Type: application/scim+json"
-H "Authorization: Bearer <really long access token here>"
-d '{ "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],"userName":"bjensen@example.com","name": {"familyName":"Jensen","givenName": "Barbara","middleName": "Jane"},"emails": [{"value": "bjensen@example.com","type": "work","primary": true}]}' "https://<domainURL>/admin/v1/Users"