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の形式で定義します。ヘッダー値はアクセスするエンドポイントによって異なります。-
リクエスト・ドキュメントのコンテンツ・タイプ。
-
OAuth 2.0認可の
X-Client-ID,
API_KEY_ID,
-
OAuth2.0認可の
X-Client-Secret,
API_KEY_SECRET,
-
-i
: レスポンス・ヘッダー情報を表示します。-X
: HTTPリクエスト・メソッド(DELETE, GET, POST, PATCH
またはPUT).
を示します。このオプションを省略する場合、デフォルトはGETです。
cURLコマンドのURL
cURLコマンドで使用されるURLは「リクエストの送信」で説明されている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"