ユーザー、アプリケーションまたはグループが承認者リストのメンバーであることの確認
/sites/management/api/v1/policies/{id}/approvers/contains
指定されたユーザー、クライアント・アプリケーションまたはグループが承認者リストの直接または間接メンバーであることを確認します。 指定したユーザーが承認者リストのメンバーでない場合、レスポンスはfalse
になります。 指定したユーザーが承認者のメンバーである場合、true
でレスポンスをリストします。
リリース19.3.3.での導入。
承認者リストの有効化
承認者リストは、関連付けられたポリシーのapprovalType
が「名前付き承認」に設定されている場合にのみ使用されます。 承認タイプ・タイプをautomatic
またはadmin
に設定した場合、承認者リストのメンバーは無視されます。 ただし、ポリシーがnamed
に設定されていない場合に承認者リストを変更することは有効です。
詳細は、「ポリシーのフィールドの更新」を参照してください。
リクエスト本文の代替識別子
リクエスト本文は、代替識別子をサポートするリソースを参照します。 これらの代替識別子は、デフォルトのリソース識別子を使用する代わりに使用できます。
「グループ」グループ名
「メンバー」リソースのデフォルトの識別子は、IDです。
グループ・メンバーは、一意のグループ名を使用して識別できます。
group:marketing
リリース19.3.1.での導入。
userユーザーまたはアプリケーション名
「メンバー」リソースのデフォルトの識別子は、IDです。
ユーザーまたはクライアント・アプリケーション・メンバーは、ユーザー名またはアプリケーション名を使用して識別できます。
user:jsmith
リリース19.3.1.での導入。
成功したレスポンスの例
この操作は、次の成功(2xx)のレスポンスで応答します。 レスポンスHTTPステータス・コードとサンプル本体の完全なリストは、この操作の「レスポンス」に関する項を参照してください。
200OK - User
ユーザーは、user:username
構文を使用して参照されます。
リクエスト
POST https://api.example.com/sites/management/api/v1/policies/{id}/approvers/contains
リクエスト本文
"user:jsmith"
200 OK - クライアント・アプリケーション
クライアント・アプリケーションは、user:applicationname
構文を使用して参照されます。
リクエスト
POST https://api.example.com/sites/management/api/v1/policies/{id}/approvers/contains
リクエスト本文
"application:MyProduct_APPID"
リリース20.3.3で導入されました。200 OK - グループ
グループを参照するには、group:groupname
構文を使用します。 Oracle Content Managementグループとアイデンティティ・プロバイダ・グループの両方の名前が同じ場合は、OCEグループが使用されます。
リクエスト
POST https://api.example.com/sites/management/api/v1/policies/{id}/approvers/contains
リクエスト本文
"group:marketing"
200 OK - Oracle Content Managementグループ
Oracle Content Managementグループは、group:oce:groupname
構文を使用して参照されます。
リクエスト
POST https://api.example.com/sites/management/api/v1/policies/{id}/approvers/contains
リクエスト本文
"group:oce:marketing"
200 OK - アイデンティティ・プロバイダ・グループ
アイデンティティ・プロバイダが提供するグループは、group:idp:groupname
構文を使用して参照されます。
リクエスト
POST https://api.example.com/sites/management/api/v1/policies/{id}/approvers/contains
リクエスト本文
"group:idp:marketing"
200 OK - 認証ユーザー
認証されたユーザーは、user:@me
構文を使用して参照できます。
リクエスト
POST https://api.example.com/sites/management/api/v1/policies/{id}/approvers/contains
リクエスト本文
"user:@me"
200OK
リクエスト
POST https://api.example.com/sites/management/api/v1/policies/{id}/approvers/contains
レスポンス本文
false
クライアント・エラー・レスポンスの例
この操作は、レスポンス本文に例外の詳細が含まれている次のクライアント・エラー(4xx)レスポンスで応答します。 レスポンスHTTPステータス・コードとサンプル本体の完全なリストは、この操作の「レスポンス」に関する項を参照してください。
400不正なリクエスト - 無効なユーザーまたはアプリケーション
識別されたユーザーまたはクライアント・アプリケーションが見つかりません。
エラー・コード
OCE-IDS-001004
解決 - ユーザーの存在確認
ユーザー名が有効であることを確認してください。
解決 - クライアント・アプリケーションが存在するかどうかの確認
クライアント・アプリケーション名が有効であることを確認してください。
例外詳細フィールド
このエラー・タイプでは、レスポンスに次のフィールド/値が含まれます:
フィールド名 | 説明 |
user | 存在しないユーザーまたはアプリケーション。 |
この例外の詳細タイプの詳細は、swaggerドキュメントの定義セクションのInvalidIdentityExceptionDetailスキーマを参照してください。
レスポンス本文の例
{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", "title": "Invalid User or Application", "status": "400", "detail": "User or client application does not exist.", "o:errorCode": "OCE-IDS-001004", "user": { "id": "1234" } }
リリース19.3.1.での導入。
400Bad Request - Invalid Group
グループ名などの識別子で識別されたグループが見つかりません。
エラー・コード
OCE-IDS-001007
解決 - グループが存在するか確認
グループ識別子またはグループ名が有効であることを確認してください。
例外詳細フィールド
このエラー・タイプでは、レスポンスに次のフィールド/値が含まれます:
フィールド名 | 説明 |
group | 存在しないグループ。 |
この例外の詳細タイプの詳細は、swaggerドキュメントの定義セクションのInvalidGroupExceptionDetailスキーマを参照してください。
レスポンス本文の例
{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", "title": "Invalid Group", "status": "400", "detail": "Group does not exist.", "o:errorCode": "OCE-IDS-001007", "group": { "id": "1234" } }
リリース19.3.1.での導入。
404Not Found - Policy Not Found
ポリシーが存在しないか削除されているか、認証されたユーザー・アプリケーションまたはクライアント・アプリケーションがポリシーへのアクセス権を持っていません。
エラー・コード
OCE-SITEMGMT-009022
解決 - 識別子のチェック
ポリシー識別子が有効であることを確認してください。
解決 - ロールのチェック
認証されたユーザーがサイト管理者であることを確認します。
解決 - アクセスの確認
ユーザーが「サイト管理者」でない場合は、ポリシー'accessType'に認証済ユーザーが含まれているかどうかを確認します。
例外詳細フィールド
このエラー・タイプでは、レスポンスに次のフィールド/値が含まれます:
フィールド名 | 説明 |
policy | 存在しないか、認証されたユーザーから表示可能でないポリシー。 |
この例外の詳細タイプの詳細は、swaggerドキュメントの定義セクションのPolicyNotFoundExceptionDetailスキーマを参照してください。
レスポンス本文の例
{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", "title": "Policy Not Found", "status": "404", "detail": "Policy does not exist or has been deleted, or the authenticated user or client application does not have access to the policy.", "o:errorCode": "OCE-SITEMGMT-009022", "policy": { "id": "721af08b-32db-4eee-b6af-0c38d3ba4681" } }
リクエスト
- application/json
- id: string
ポリシーのグローバル一意識別子。
メンバーシップをチェックするユーザーまたはグループ。
string
"user:jsmith"
レスポンス
- application/json
200レスポンス
- Cache-Control: string
キャッシュ・メカニズムのディレクティブ。
- Content-Length: string
レスポンス本文のサイズ。
- Content-Type: string
レスポンスのコンテンツ・タイプ。
- ETag: string
オリジン・サーバーによって特定のバージョンのリソースに割り当てられた不透明識別子。
boolean
false
400レスポンス
- object ExceptionDetail
HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。
- object InvalidIdentityExceptionDetail-allOf[1]
object
HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。
- detail(optional): string
この問題の発生に固有の説明。 人間が判読できる、場合によっては複数行の詳細で問題を説明しています。
- instance(optional): string(uri)
エラーに関する詳細を提供するリンクへのURI。
- o:errorCode(optional): string
アプリケーション・エラー・コード。HTTPエラー・コードとは異なります。 このコードは、
title
やdetail
などのフィールドを比較するのではなく、特定のエラーをチェックするために使用する必要があります。 - o:errorDetails(optional): array o:errorDetails
階層構造に複数のエラーがある場合もあります。
- o:errorPath(optional): string
エラーが発生した場所を示すXPathまたはJSONパス。
- status(optional): integer(int32)
エラーに対応するHTTPステータス・コード。
- title(optional): string
問題の短く、判読可能なサマリー。 タイトルは、特定のエラーをチェックする方法としては使用しないでください。そのためには
o:errorCode
を使用してください。 - type(optional): string(uri)
問題のタイプを識別する絶対URI。 このURIが参照解除されると、「推奨」は、HTMLページなどの問題の判読可能なサマリーを提供します。
object
- user(optional): string
存在しないユーザーまたはアプリケーション。
リリース19.3.1.での導入。
- object ExceptionDetail
HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Invalid User or Application",
"status":"400",
"detail":"User or client application does not exist.",
"o:errorCode":"OCE-IDS-001004",
"user":{
"id":"1234"
}
}
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Invalid Group",
"status":"400",
"detail":"Group does not exist.",
"o:errorCode":"OCE-IDS-001007",
"group":{
"id":"1234"
}
}
401レスポンス
403レスポンス
404レスポンス
- Cache-Control: string
キャッシュ・メカニズムのディレクティブ。
- Content-Length: string
レスポンス本文のサイズ。
- Content-Type: string
レスポンスのコンテンツ・タイプ。
- object ExceptionDetail
HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。
- object PolicyNotFoundExceptionDetail-allOf[1]
object
HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。
- detail(optional): string
この問題の発生に固有の説明。 人間が判読できる、場合によっては複数行の詳細で問題を説明しています。
- instance(optional): string(uri)
エラーに関する詳細を提供するリンクへのURI。
- o:errorCode(optional): string
アプリケーション・エラー・コード。HTTPエラー・コードとは異なります。 このコードは、
title
やdetail
などのフィールドを比較するのではなく、特定のエラーをチェックするために使用する必要があります。 - o:errorDetails(optional): array o:errorDetails
階層構造に複数のエラーがある場合もあります。
- o:errorPath(optional): string
エラーが発生した場所を示すXPathまたはJSONパス。
- status(optional): integer(int32)
エラーに対応するHTTPステータス・コード。
- title(optional): string
問題の短く、判読可能なサマリー。 タイトルは、特定のエラーをチェックする方法としては使用しないでください。そのためには
o:errorCode
を使用してください。 - type(optional): string(uri)
問題のタイプを識別する絶対URI。 このURIが参照解除されると、「推奨」は、HTMLページなどの問題の判読可能なサマリーを提供します。
object
- policy(optional): string
存在しないか、認証されたユーザーから表示可能でないポリシー。
- object ExceptionDetail
HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Policy Not Found",
"status":"404",
"detail":"Policy does not exist or has been deleted, or the authenticated user or client application does not have access to the policy.",
"o:errorCode":"OCE-SITEMGMT-009022",
"policy":{
"id":"721af08b-32db-4eee-b6af-0c38d3ba4681"
}
}