リクエストの送信
アイデンティティ・ドメインREST APIを使用して送信リクエストを作成する場合は、次のガイドラインに従います。
URLの構造
RESTエンドポイント、アクセスするリソース、およびリクエストに含める問合せパラメータを含むURLを使用して、アイデンティティ・ドメインREST APIにアクセスします。Oracle Cloud管理者またはアイデンティティ・ドメイン管理者から、アイデンティティ・ドメインREST APIの完全なURL構造を取得します。
基本エンドポイント
アイデンティティ・ドメインREST APIの基本的なエンドポイントは次のとおりです。
https://<domainURL>/ここで、domainURLはドメイン固有のURLを表します。アイデンティティ・ドメイン・コンソールを使用してこのURLを取得するには、アイデンティティ・ドメインURLの検索を参照してください。
または、Oracle Cloud管理者またはアイデンティティ・ドメイン管理者からこのURLを取得します。
リソース・エンドポイント
新規リソースを作成したり、リソース・タイプのメンバーの検索を実行するとき、リソースの名前を追加します。たとえば、POSTリクエストを送信して新規ユーザーを作成するときに、エンドポイントを使用します。
https://<domainURL>/admin/v1/Usersエンドポイント内の特定リソース
特定のリソースにアクセスするには、そのリソースのid属性の値をリソース・エンドポイントに追加します。たとえば、ユーザーを作成し、POSTリクエストに対するレスポンスのレスポンス本文にocid値ocid1.user.oc1..xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxが含まれる場合、次のエンドポイントを使用して、後続のGET, PATCHまたはPUTリクエストで特定のユーザー・リソースにアクセスします。
https://<domainURL>/admin/v1/Users/ocid1.user.oc1..xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxサポートされているメソッド
サポートされているメソッドはエンドポイントによって異なります。
| HTTPメソッド | 説明 |
|---|---|
GET
|
リソースの検索、またはIDによる特定リソースの検索を行います。 |
HEAD |
リソースの存在や変更を確認します。レスポンス本文を返しません。読取り専用 |
POST
|
アイデンティティ・ドメイン・リソースの作成、変更、リセット、インポート、認証または検索リクエストの作成を行います。 |
PUT
|
既存のアイデンティティ・ドメイン・リソースを置換(完全更新)、アイデンティティ・ドメイン・リソースをアクティブ化または非アクティブ化するなど。 |
PATCH
|
アイデンティティ・ドメイン・リソースを変更(一部更新)します。 |
DELETE
|
アイデンティティ・ドメイン・リソースを削除または取り消します。 |
OPTIONS |
エンドポイントに対して許可される操作を取得します。 |
サポートされているヘッダー
アイデンティティ・ドメインREST APIでは、HTTPリクエストまたはレスポンスのヘッダー・セクションに渡される可能性のある次のヘッダーをサポートしています。
| ヘッダー | 説明 | 例 |
|---|---|---|
Content-Type
|
リクエストの本体のメディア・タイプ。POSTおよびPUTリクエストで必要です。 |
Content-Type: application/scim+json Content-Type: application/json
|
Authorization
|
保護されているリソースにアクセスするために使用されるOAuthアクセス・トークン または、Authorizationヘッダー内のリクエスト署名 |
アクセス・トークンは非常に長い文字列です。この例は切り詰められています: Bearer VkdVAZrb_fw......eyJ4NXQjUzI1Ni |