cURLの使用
cURLは、URL構文でデータを転送するためのオープン・ソースのコマンドライン・ツールで、HTTPやHTTPSなど様々なプロトコルをサポートします。このドキュメント内の例では、cURLを使用して、アイデンティティ・ドメインのREST APIにアクセスする方法を示しています。
cURLを使用したREST APIへのアクセス
-
cURLをインストールします。ステップ2: cURLのインストールを参照してください。
-
コマンド・ウィンドウで、cURL環境変数
CURL_CA_BUNDLEを、ローカルのCA証明書バンドルの場所に設定します。cURLを使用したCA証明書の検証の詳細は、http://curl.haxx.se/docs/sslcerts.html.を参照してください -
cURLを起動して、次のコマンドライン・オプションを必要に応じて1つ以上指定して、その実行を指示します。
-d, --data @file.json: ローカル・マシン上のJSON形式のリクエスト・ドキュメントを識別します。-F, --form @file.json: ローカル・マシン上のJSON形式のフォーム・データを識別します。-H, --header: リクエスト・ヘッダーをHEADER: VALUEの形式として定義します。ヘッダー値は、アクセスしているエンドポイントによって異なります。-
リクエスト・ドキュメントのコンテンツ・タイプ。
-
X-Client-ID,API_KEY_ID,(OAuth 2.0認可) -
OAuth2.0認可の
X-Client-Secret,API_KEY_SECRET,
-
-i: レスポンス・ヘッダー情報を表示します。-X: HTTPリクエスト・メソッド(DELETE, GET, POST, PATCH、またはPUT).を示します。このオプションを指定しない場合、デフォルトはGETです。
cURLコマンドURL
cURLコマンドで使用されるURLは「リクエストの送信」で説明されているものと同じですが、URL内の空白はプラス文字(+)に、引用符(")は%22に置き換える必要があります。
URL内にASCII文字セット以外の文字列(空白や引用符など)が含まれる場合は、URLエンコードする必要があります。たとえば、次のURLには、ユーザー名にjenが含まれている、またはbjで始まるユーザーのフィルタ問合せが含まれます。空白が含まれていることに注意してください。
https://<domainURL>/admin/v1/Users?filter=userName co "jen" or userName sw "bj"
このURLをcURLコマンド・ラインで使用するには、次のように変更します。
https://<domainURL>/admin/v1/Users?filter=userName+co+%22jen%22+or+userName+sw+%22bj%22
GETリクエストを送信するためのcURLコマンド
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"
POSTリクエストを送信するためのcURLコマンド
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"