リクエストの送信

アイデンティティ・ドメインREST APIを使用して送信リクエストを作成する場合は、次のガイドラインに従います。

URL構造

RESTエンドポイントを含むURL、アクセスするリソース、およびリクエストに含める問合せパラメータが含まれる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リクエストに対するレスポンスのレスポンス本文にocidocid1.user.oc1..xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxが含まれる場合、後続のGET, PATCHまたはPUTリクエストで、次のエンドポイントを使用して特定のユーザー・リソースにアクセスします。

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

サポートされるメソッド

アイデンティティ・ドメインREST APIでは、次のリクエスト・メソッドがサポートされています。
ノート

サポートされているメソッドはエンドポイントによって異なります。
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アクセス・トークン

または、認可ヘッダーのリクエスト署名

アクセス・トークンは非常に長い文字列です。この例は切り捨てられました: Bearer VkdVAZrb_fw......eyJ4NXQjUzI1Ni