アクセス・リストへのユーザー、アプリケーションまたはグループの追加
/sites/management/api/v1/policies/{id}/access
アクセス・リストに単一のユーザー、クライアント・アプリケーションまたはグループを追加します。 ユーザー、クライアント・アプリケーションまたはグループ名がユーザー、クライアント・アプリケーションまたはグループに一致しない場合、無効なユーザー、クライアント・アプリケーションまたはグループ・エラー・レスポンスが返されます。 ユーザー、クライアント・アプリケーションまたはグループがすでにアクセス・リストのメンバーである場合、レスポンスにはメンバーがすでに存在するエラーが含まれます。
リリース19.3.1.での導入。
認可
ユーザー、クライアント・アプリケーションおよびグループは、「サイト管理者」によってのみアクセス・リストに追加できます。
アクセス・リストの有効化
アクセス・リストは、関連するポリシーのaccessType
がrestricted
に設定されている場合にのみ使用されます。 アクセス・タイプがeveryone
に設定されている場合、アクセス・リストのメンバーは無視されます。 ただし、ポリシー・アクセス・タイプがeveryone
に設定されている場合にアクセス・リスト・メンバーを変更することは有効です。
詳細は、「ポリシーのフィールドの更新」を参照してください。
成功したレスポンスの例
この操作は、次の成功(2xx)のレスポンスで応答します。 レスポンスHTTPステータス・コードとサンプル本体の完全なリストは、この操作の「レスポンス」に関する項を参照してください。
200OK - Add User
ユーザーの追加にはuser:username
構文を使用します。
リクエスト
POST https://api.example.com/sites/management/api/v1/policies/{id}/access
リクエスト本文
"user:jsmith"
200 OK - アプリケーションの追加
クライアント・アプリケーションは、user:applicationname
構文を使用して追加されます。
リクエスト
POST https://api.example.com/sites/management/api/v1/policies/{id}/access
リクエスト本文
"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}/access
リクエスト本文
"group:marketing"
200 OK - Oracle Content Managementグループの追加
Oracle Content Managementグループは、group:oce:groupname
構文を使用して参照されます。 OCEグループとアイデンティティ・プロバイダ・グループの間に名前の衝突がある場合、この構文を使用して、追加されるグループのタイプについて明示的に記述できます。
リクエスト
POST https://api.example.com/sites/management/api/v1/policies/{id}/access
リクエスト本文
"group:oce:marketing"
200 OK - アイデンティティ・プロバイダ・グループの追加
アイデンティティ・プロバイダが提供するグループは、group:idp:groupname
構文を使用して参照されます。 Oracle Content ManagementグループとIDPグループの間に名前の衝突がある場合、この構文を使用して、追加されるグループのタイプについて明示できます。
リクエスト
POST https://api.example.com/sites/management/api/v1/policies/{id}/access
リクエスト本文
"group:idp:marketing"
200OK
リクエスト
POST https://api.example.com/sites/management/api/v1/policies/{id}/access
レスポンス本文
{ "id": "user:jsmith", "type": "user", "name": "jsmith", "displayName": "John Smith", "isExternalUser": 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.での導入。
400Bad Request - Unsupported Policy Field
ポリシーのフィールドを指定しないことを示します。 たとえば、標準テンプレートのポリシーにリポジトリを指定することはできません。
エラー・コード
OCE-SITEMGMT-009036
解決 - ローカリゼーション・ポリシーの削除許可
関連付けられているテンプレートが標準テンプレートの場合は、ポリシーのlocalizationPolicyAllowed
フィールドを削除します。
解決 - 使用可能なサイト・プレフィクスの削除
関連付けられているテンプレートが標準テンプレートの場合は、ポリシーのsitePrefixAllowed
フィールドを削除します。
解決 - リポジトリの削除
関連付けられているテンプレートが標準テンプレートの場合は、ポリシーのrepository
フィールドを削除します。
例外詳細フィールド
このエラー・タイプでは、レスポンスに次のフィールド/値が含まれます:
フィールド名 | 説明 |
field | サイトのタイプと互換性がないフィールド名。 |
この例外の詳細タイプの詳細は、swaggerドキュメントの定義セクションのUnsupportedPolicyFieldExceptionDetailスキーマを参照してください。
レスポンス本文の例
{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", "title": "Unsupported Policy Field", "status": "400", "detail": "Field '{field}' should not be provided for this policy.", "o:errorCode": "OCE-SITEMGMT-009036", "field": "repository" }
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" } }
409Conflict - Policy Read Only
ポリシーは読取り専用であり、変更できません。 テンプレートまたはサイトに関連付けられているポリシーのみ編集できます。 リクエストに関連付けられているポリシーは読取り専用です。
エラー・コード
OCE-SITEMGMT-009032
解決 - テンプレート・ポリシーの編集
テンプレートに関連付けられたポリシーを変更することを目的としている場合は、テンプレート・ポリシー・リソースからポリシー識別子を使用します。
解決 - コピー・サイト・ポリシーの編集
サイトのコピー操作に関連付けられているポリシーを変更することを目的としている場合は、コピー操作ポリシー・リソースからポリシー識別子を使用します。
解決 - サイトの拡張有効期限ポリシーの編集
サイトのコピー操作に関連付けられているポリシーを変更することを目的としている場合は、拡張サイトの有効期限操作のポリシー・リソースからポリシー識別子を使用します。
例外詳細フィールド
このエラー・タイプでは、レスポンスに次のフィールド/値が含まれます:
フィールド名 | 説明 |
policy | 読取り専用ポリシー。 |
この例外の詳細タイプの詳細は、swaggerドキュメントの定義セクションのPolicyReadOnlyExceptionDetailスキーマを参照してください。
レスポンス本文の例
{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", "title": "Policy Read Only", "status": "409", "detail": "The policy is read-only and cannot be modified.", "o:errorCode": "OCE-SITEMGMT-009032", "policy": { "id": "721af08b-32db-4eee-b6af-0c38d3ba4681" } }
409Conflict - Member Already Exists
ユーザー、クライアント・アプリケーションまたはグループはすでにメンバーです。
エラー・コード
OCE-IDS-001005
例外詳細フィールド
このエラー・タイプでは、レスポンスに次のフィールド/値が含まれます:
フィールド名 | 説明 |
member | メンバー識別子。 |
この例外の詳細タイプの詳細は、swaggerドキュメントの定義セクションのMemberAlreadyExistsExceptionDetailスキーマを参照してください。
レスポンス本文の例
{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", "title": "Member Already Exists", "status": "409", "detail": "User or group '{member.id}' is already a member'.", "o:errorCode": "OCE-IDS-001005", "member": { "id": "user:jsmith" } }
リリース19.3.1.での導入。
リクエスト
- application/json
- id: string
ポリシーのグローバル一意識別子。
追加されるユーザー、クライアント・アプリケーションまたはグループの詳細。
string
"user:jsmith"
レスポンス
- application/json
- application/vnd.oracle.resource+json;type=singular
201レスポンス
- Cache-Control: string
キャッシュ・メカニズムのディレクティブ。
- Content-Length: string
レスポンス本文のサイズ。
- Content-Type: string
レスポンスのコンテンツ・タイプ。
- ETag: string
オリジン・サーバーによって特定のバージョンのリソースに割り当てられた不透明識別子。
- Location: string
リソースのロケーション。
object
- displayName(optional): string
ユーザー、クライアント・アプリケーションまたはグループの表示名。
リリース19.3.1.での導入。 - group(optional): グループ
メンバーのグループ詳細。 メンバーのタイプが「グループ」の場合にのみ使用できます。
リリース19.3.1.での導入。 - groupType(optional): string
メンバーがグループの場合、グループのタイプが指定されます。 メンバーがユーザーの場合、このフィールドは存在しません。
有効な値は次のとおりです。
-
oce
- コンテンツ管理グループ -
idp
- アイデンティティ・プロバイダ・グループ
-
- id: string
ユーザー、クライアント・アプリケーションまたはグループ・メンバーの識別子。
フィールドの内容は想定しないでください。フィールドはopaque値として扱われる必要があります。
リリース19.3.1.での導入。 - isExternalUser(optional): boolean
関連するユーザーまたはクライアント・アプリケーションに外部ユーザー・ロールのみがある場合、trueに設定されます。
リリース21.10.2で導入されました。 - links(optional): array links
このリソースに対する関連リソースおよびアクションへのHATEOSリンク。 リソースの正規表現へのリンクを含む自己リンクを少なくとも1つ含める必要があります。
- name: string
ユーザー、クライアント・アプリケーションまたはグループの一意の名前。 メンバーがユーザーの場合、名前はユーザー名です。 メンバーがグループの場合、名前はグループ名です。
リリース19.3.1.での導入。 - type: string
メンバーがユーザー、クライアント・アプリケーションまたはグループであることを示します。
有効な値は次のとおりです。
-
user
- メンバーはユーザーまたはクライアント・アプリケーションです。 ユーザーまたはメンバー間で区別されません
-
group
- メンバーはグループです
-
- user(optional): user
メンバーのユーザーまたはクライアント・アプリケーションの詳細。 メンバーのタイプがuserの場合にのみ使用できます。 メンバーは、ユーザー、クライアント・アプリケーションまたはグループにすることができます。 ユーザーとクライアント・アプリケーションの両方の詳細を読むことができます。
リリース19.3.1.での導入。
array
このリソースに対する関連リソースおよびアクションへのHATEOSリンク。 リソースの正規表現へのリンクを含む自己リンクを少なくとも1つ含める必要があります。
メンバーのユーザーまたはクライアント・アプリケーションの詳細。 メンバーのタイプがuserの場合にのみ使用できます。 メンバーは、ユーザー、クライアント・アプリケーションまたはグループにすることができます。 ユーザーとクライアント・アプリケーションの両方の詳細を読むことができます。
リリース19.3.1.での導入。- allOf 「アイデンティティ」
識別子:
type
ユーザーまたはクライアント・アプリケーションを表すアイデンティティ。 アイデンティティには、アイデンティティ識別子、一意の名前、表示名などの共通情報が含まれます。
リリース20.3.1で導入されました。
グループとは、ユーザーおよびグループの集合です。 グループには、ユーザーが読取り可能なグループ名があります。
リリース19.3.1.での導入。- object SingularResource
すべての単数形のリソースには、特異なリソース定義のプロパティが含まれます。 単一のリソースには、他のリソースとの関係を提供するリンク、またはリソース自体をselfがリンクするリンク先のリストが含まれます。
- object Group-allOf[1]
object
すべての単数形のリソースには、特異なリソース定義のプロパティが含まれます。 単一のリソースには、他のリソースとの関係を提供するリンク、またはリソース自体をselfがリンクするリンク先のリストが含まれます。
- links(optional): array links
このリソースに対する関連リソースおよびアクションへのHATEOSリンク。 リソースの正規表現へのリンクを含む自己リンクを少なくとも1つ含める必要があります。
object
- displayName(optional): string
グループに対する、人間が読み取り可能な名前。
リリース19.3.1.での導入。 - groupName(optional): string
サービス・インスタンス内で一意のグループ名。
リリース19.3.1.での導入。 - id(optional): string
グループの一意の識別子。
フィールドの内容は想定しないでください。フィールドはopaque値として扱われる必要があります。
リリース19.3.1.での導入。 - roles(optional): array roles
ロール
有効な値は次のとおりです。
-
CECServiceAdministrator
- サービス管理者
- ユーザー列挙の割当
- ユーザーのパスワードおよびチャレンジ質問の変更
- サービス・インスタンスの構成、モニターおよび管理
-
CECSitesAdministrator
- サイト管理者
- サイト、テンプレート、テーマまたはコンポーネントの作成
-
CECRepositoryAdministrator
- リポジトリ管理者 -
CECDeveloperUser
- 開発者ユーザー -
CECContentAdministrator
- コンテンツ管理者
- 新規コンテンツ・タイプの作成およびアイテムの公開
-
CECStandardUser
- 標準ユーザー
- コンテンツの管理(ドキュメントの表示、アップロードおよび編集)
- 他のユーザーとのコンテンツおよびサイトの共有
- 会話によるコラボレーション(トピックのディスカッション、他のユーザーへのメッセージの送信、他のユーザーへのフラグの割当て、ドキュメントへの注釈の追加)
- ユーザーのフォロー
- サイトの作成、編集および公開
- サイトのテーマの管理および公開
- カスタム・サイト・コンポーネントの作成、登録、エクスポートおよびインポート
- サイト・テンプレートの作成、編集、エクスポートおよびインポート
- サイト内のコンテンツの表示および操作
- カスタム・プロパティの管理と表示、および値の編集
-
CECEnterpriseUser
- エンタープライズ・ユーザー
- コンテンツの管理(ドキュメントの表示、アップロードおよび編集)
- 他のユーザーとのコンテンツおよびサイトの共有
- 会話によるコラボレーション(トピックのディスカッション、他のユーザーへのメッセージの送信、他のユーザーへのフラグの割当て、ドキュメントへの注釈の追加)
- ユーザーのフォロー
- デジタル・アセット
- コンテンツ・アイテム(エディトリアル・コンテンツ管理)
- コンテンツ・アイテムの作成、管理、表示および操作
- コレクション
- サイトの作成、編集および公開
- サイトのテーマの管理および公開
- カスタム・サイト・コンポーネントの作成、登録、エクスポートおよびインポート
- サイト・テンプレートの作成、編集、エクスポートおよびインポート
- カスタム・プロパティの管理と表示、および値の編集
-
CECExternalUser
- 外部ユーザー
-
CECIntegrationUser
- 統合ユーザー
-
CECSitesVisitor
- サイト・ビジター
-
- type(optional): string
グループのタイプ。
有効な値は次のとおりです。
-
oce
- コンテンツ管理グループ -
idp
- アイデンティティ・プロバイダ・グループ
-
array
このリソースに対する関連リソースおよびアクションへのHATEOSリンク。 リソースの正規表現へのリンクを含む自己リンクを少なくとも1つ含める必要があります。
object
REST HATEOASリンクおよび関連メタデータ。 レスポンスがリンクを提供する場合(リソース自体へのself
リンクなど)、提供されるリンクには、このリンク構造で定義された1つ以上のプロパティが含まれます。
- href(optional): string
ターゲット・リソースのURI URI RFC3986またはURIテンプレートRFC6570。 値がURIテンプレートに設定されている場合、
templated
プロパティをtrue
に設定する必要があります。 - mediaType(optional): string
メディア・タイプ。RFC 2046で定義され、リンク・ターゲットを記述します。
- method(optional): string
リンクのターゲットをリクエストするためのHTTPメソッド。
有効な値は次のとおりです。
-
OPTIONS
- HTTP OPTIONS -
HEAD
- HTTP HEAD -
GET
- HTTP GET -
POST
- HTTP POST -
PUT
- HTTP PUT -
PATCH
- HTTP PATCH -
DELETE
- HTTP DELETE
-
- profile(optional): string(uri)
ターゲット・リソースを参照解除するときにリソースを指定するJSONスキーマなどのリソースのメタデータへのリンク。
- rel(optional): string
リンクの詳細を取得するために使用できるリンク・リレーションの名前。
- templated(optional): boolean
href
プロパティを指定するブール・フラグは、URIまたはURIテンプレートです。 プロパティが存在しない場合、false
とみなすことができます。
array
ロール
有効な値は次のとおりです。
-
CECServiceAdministrator
- サービス管理者
- ユーザー列挙の割当
- ユーザーのパスワードおよびチャレンジ質問の変更
- サービス・インスタンスの構成、モニターおよび管理
-
CECSitesAdministrator
- サイト管理者
- サイト、テンプレート、テーマまたはコンポーネントの作成
-
CECRepositoryAdministrator
- リポジトリ管理者 -
CECDeveloperUser
- 開発者ユーザー -
CECContentAdministrator
- コンテンツ管理者
- 新規コンテンツ・タイプの作成およびアイテムの公開
-
CECStandardUser
- 標準ユーザー
- コンテンツの管理(ドキュメントの表示、アップロードおよび編集)
- 他のユーザーとのコンテンツおよびサイトの共有
- 会話によるコラボレーション(トピックのディスカッション、他のユーザーへのメッセージの送信、他のユーザーへのフラグの割当て、ドキュメントへの注釈の追加)
- ユーザーのフォロー
- サイトの作成、編集および公開
- サイトのテーマの管理および公開
- カスタム・サイト・コンポーネントの作成、登録、エクスポートおよびインポート
- サイト・テンプレートの作成、編集、エクスポートおよびインポート
- サイト内のコンテンツの表示および操作
- カスタム・プロパティの管理と表示、および値の編集
-
CECEnterpriseUser
- エンタープライズ・ユーザー
- コンテンツの管理(ドキュメントの表示、アップロードおよび編集)
- 他のユーザーとのコンテンツおよびサイトの共有
- 会話によるコラボレーション(トピックのディスカッション、他のユーザーへのメッセージの送信、他のユーザーへのフラグの割当て、ドキュメントへの注釈の追加)
- ユーザーのフォロー
- デジタル・アセット
- コンテンツ・アイテム(エディトリアル・コンテンツ管理)
- コンテンツ・アイテムの作成、管理、表示および操作
- コレクション
- サイトの作成、編集および公開
- サイトのテーマの管理および公開
- カスタム・サイト・コンポーネントの作成、登録、エクスポートおよびインポート
- サイト・テンプレートの作成、編集、エクスポートおよびインポート
- カスタム・プロパティの管理と表示、および値の編集
-
CECExternalUser
- 外部ユーザー
-
CECIntegrationUser
- 統合ユーザー
-
CECSitesVisitor
- サイト・ビジター
type
ユーザーまたはクライアント・アプリケーションを表すアイデンティティ。 アイデンティティには、アイデンティティ識別子、一意の名前、表示名などの共通情報が含まれます。
リリース20.3.1で導入されました。- object SingularResource
すべての単数形のリソースには、特異なリソース定義のプロパティが含まれます。 単一のリソースには、他のリソースとの関係を提供するリンク、またはリソース自体をselfがリンクするリンク先のリストが含まれます。
- object Identity-allOf[1]
object
- displayName(optional): string
人間が判読できる表示名。
リリース20.3.1で導入されました。 - id(optional): string
ユーザーまたはクライアント・アプリケーションに対してCECによって割り当てられる識別子値。 識別子はサービスのスコープ内で一意です。
フィールドの内容は想定しないでください。フィールドはopaque値として扱われる必要があります。
リリース20.3.1で導入されました。 - name(optional): string
ユーザー名やクライアント・アプリケーション名などの一意の名前。
リリース20.3.1で導入されました。 - roles(optional): array roles
ロール
有効な値は次のとおりです。
-
CECServiceAdministrator
- サービス管理者
- ユーザー列挙の割当
- ユーザーのパスワードおよびチャレンジ質問の変更
- サービス・インスタンスの構成、モニターおよび管理
-
CECSitesAdministrator
- サイト管理者
- サイト、テンプレート、テーマまたはコンポーネントの作成
-
CECRepositoryAdministrator
- リポジトリ管理者 -
CECDeveloperUser
- 開発者ユーザー -
CECContentAdministrator
- コンテンツ管理者
- 新規コンテンツ・タイプの作成およびアイテムの公開
-
CECStandardUser
- 標準ユーザー
- コンテンツの管理(ドキュメントの表示、アップロードおよび編集)
- 他のユーザーとのコンテンツおよびサイトの共有
- 会話によるコラボレーション(トピックのディスカッション、他のユーザーへのメッセージの送信、他のユーザーへのフラグの割当て、ドキュメントへの注釈の追加)
- ユーザーのフォロー
- サイトの作成、編集および公開
- サイトのテーマの管理および公開
- カスタム・サイト・コンポーネントの作成、登録、エクスポートおよびインポート
- サイト・テンプレートの作成、編集、エクスポートおよびインポート
- サイト内のコンテンツの表示および操作
- カスタム・プロパティの管理と表示、および値の編集
-
CECEnterpriseUser
- エンタープライズ・ユーザー
- コンテンツの管理(ドキュメントの表示、アップロードおよび編集)
- 他のユーザーとのコンテンツおよびサイトの共有
- 会話によるコラボレーション(トピックのディスカッション、他のユーザーへのメッセージの送信、他のユーザーへのフラグの割当て、ドキュメントへの注釈の追加)
- ユーザーのフォロー
- デジタル・アセット
- コンテンツ・アイテム(エディトリアル・コンテンツ管理)
- コンテンツ・アイテムの作成、管理、表示および操作
- コレクション
- サイトの作成、編集および公開
- サイトのテーマの管理および公開
- カスタム・サイト・コンポーネントの作成、登録、エクスポートおよびインポート
- サイト・テンプレートの作成、編集、エクスポートおよびインポート
- カスタム・プロパティの管理と表示、および値の編集
-
CECExternalUser
- 外部ユーザー
-
CECIntegrationUser
- 統合ユーザー
-
CECSitesVisitor
- サイト・ビジター
-
- type(optional): string
「アイデンティティ」のタイプ。 有効な値は次のとおりです:
リリース20.3.1で導入されました。user
,service
,application
,unknown
。
array
ロール
有効な値は次のとおりです。
-
CECServiceAdministrator
- サービス管理者
- ユーザー列挙の割当
- ユーザーのパスワードおよびチャレンジ質問の変更
- サービス・インスタンスの構成、モニターおよび管理
-
CECSitesAdministrator
- サイト管理者
- サイト、テンプレート、テーマまたはコンポーネントの作成
-
CECRepositoryAdministrator
- リポジトリ管理者 -
CECDeveloperUser
- 開発者ユーザー -
CECContentAdministrator
- コンテンツ管理者
- 新規コンテンツ・タイプの作成およびアイテムの公開
-
CECStandardUser
- 標準ユーザー
- コンテンツの管理(ドキュメントの表示、アップロードおよび編集)
- 他のユーザーとのコンテンツおよびサイトの共有
- 会話によるコラボレーション(トピックのディスカッション、他のユーザーへのメッセージの送信、他のユーザーへのフラグの割当て、ドキュメントへの注釈の追加)
- ユーザーのフォロー
- サイトの作成、編集および公開
- サイトのテーマの管理および公開
- カスタム・サイト・コンポーネントの作成、登録、エクスポートおよびインポート
- サイト・テンプレートの作成、編集、エクスポートおよびインポート
- サイト内のコンテンツの表示および操作
- カスタム・プロパティの管理と表示、および値の編集
-
CECEnterpriseUser
- エンタープライズ・ユーザー
- コンテンツの管理(ドキュメントの表示、アップロードおよび編集)
- 他のユーザーとのコンテンツおよびサイトの共有
- 会話によるコラボレーション(トピックのディスカッション、他のユーザーへのメッセージの送信、他のユーザーへのフラグの割当て、ドキュメントへの注釈の追加)
- ユーザーのフォロー
- デジタル・アセット
- コンテンツ・アイテム(エディトリアル・コンテンツ管理)
- コンテンツ・アイテムの作成、管理、表示および操作
- コレクション
- サイトの作成、編集および公開
- サイトのテーマの管理および公開
- カスタム・サイト・コンポーネントの作成、登録、エクスポートおよびインポート
- サイト・テンプレートの作成、編集、エクスポートおよびインポート
- カスタム・プロパティの管理と表示、および値の編集
-
CECExternalUser
- 外部ユーザー
-
CECIntegrationUser
- 統合ユーザー
-
CECSitesVisitor
- サイト・ビジター
{
"id":"user:jsmith",
"type":"user",
"name":"jsmith",
"displayName":"John Smith",
"isExternalUser":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"
}
}
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Unsupported Policy Field",
"status":"400",
"detail":"Field '{field}' should not be provided for this policy.",
"o:errorCode":"OCE-SITEMGMT-009036",
"field":"repository"
}
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"
}
}
406レスポンス
409レスポンス
- object ExceptionDetail
HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。
- object PolicyReadOnlyExceptionDetail-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 Read Only",
"status":"409",
"detail":"The policy is read-only and cannot be modified.",
"o:errorCode":"OCE-SITEMGMT-009032",
"policy":{
"id":"721af08b-32db-4eee-b6af-0c38d3ba4681"
}
}
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Member Already Exists",
"status":"409",
"detail":"User or group '{member.id}' is already a member'.",
"o:errorCode":"OCE-IDS-001005",
"member":{
"id":"user:jsmith"
}
}