機械翻訳について
  1. サイト管理用のREST API
  2. タスク
  3. ポリシー
  4. 承認リスト

承認者リストへのユーザー、アプリケーションまたはグループの追加

post

/sites/management/api/v1/policies/{id}/approvers

COLLECTION

承認者リストに単一ユーザー、クライアント・アプリケーションまたはグループを追加します。 ユーザー、クライアント・アプリケーションまたはグループ名がユーザー、クライアント・アプリケーションまたはグループに一致しない場合、無効なユーザー、クライアント・アプリケーションまたはグループ・エラー・レスポンスが返されます。 ユーザー、クライアント・アプリケーションまたはグループがすでに承認者である場合、レスポンスにはメンバーが存在しています。

リリース19.3.3.での導入。

認可

ユーザー、クライアント・アプリケーションおよびグループは、「サイト管理者」によってのみ承認リストに追加できます。

承認者リストの有効化

承認者リストは、関連付けられたポリシーのapprovalTypeが「名前付き承認」に設定されている場合にのみ使用されます。 承認タイプ・タイプをautomaticまたはadminに設定した場合、承認者リストのメンバーは無視されます。 ただし、ポリシーがnamedに設定されていない場合に承認者リストを変更することは有効です。

詳細は、「ポリシーのフィールドの更新」を参照してください。

成功したレスポンスの例

この操作は、次の成功(2xx)のレスポンスで応答します。 レスポンスHTTPステータス・コードとサンプル本体の完全なリストは、この操作の「レスポンス」に関する項を参照してください。

200OK - Add User

ユーザーの追加にはuser:username構文を使用します。

リクエスト

POST https://api.example.com/sites/management/api/v1/policies/{id}/approvers

リクエスト本文

"user:jsmith"

200 OK - アプリケーションの追加

クライアント・アプリケーションは、user:applicationname構文を使用して追加されます。

リクエスト

POST https://api.example.com/sites/management/api/v1/policies/{id}/approvers

リクエスト本文

"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

リクエスト本文

"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}/approvers

リクエスト本文

"group:oce:marketing"

200 OK - アイデンティティ・プロバイダ・グループの追加

アイデンティティ・プロバイダが提供するグループは、group:idp:groupname構文を使用して参照されます。 Oracle Content ManagementグループとIDPグループの間に名前の衝突がある場合、この構文を使用して、追加されるグループのタイプについて明示できます。

リクエスト

POST https://api.example.com/sites/management/api/v1/policies/{id}/approvers

リクエスト本文

"group:idp:marketing"

200OK

リクエスト

POST https://api.example.com/sites/management/api/v1/policies/{id}/approvers

レスポンス本文

{
  "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.での導入。

リクエスト

サポートされているメディア・タイプ
パス・パラメータ

  • ポリシーのグローバル一意識別子。

本文()

追加されるユーザー、クライアント・アプリケーションまたはグループの詳細。

ルート・スキーマ: schema
型: string
例:
"user:jsmith"
トップに戻る

レスポンス

サポートされているメディア・タイプ

201レスポンス

作成日
ヘッダー
本文()
ルート・スキーマ: schema
型: object
ソースを表示

  • ユーザー、クライアント・アプリケーションまたはグループの表示名。

    リリース19.3.3.での導入。
  • グループ

    メンバーのグループ詳細。 メンバーのタイプが「グループ」の場合にのみ使用できます。

    リリース19.3.3.での導入。

  • メンバーがグループの場合、グループのタイプが指定されます。 メンバーがユーザーの場合、このフィールドは存在しません。

    有効な値は次のとおりです。

    • oce - コンテンツ管理グループ
    • idp - アイデンティティ・プロバイダ・グループ

    リリース20.1.1で導入されました。

  • ユーザー、クライアント・アプリケーションまたはグループ・メンバーの識別子。

    フィールドの内容は想定しないでください。フィールドはopaque値として扱われる必要があります。

    リリース19.3.3.での導入。

  • 関連するユーザーまたはクライアント・アプリケーションに外部ユーザー・ロールのみがある場合、trueに設定されます。

    リリース21.10.2で導入されました。
  • links

    このリソースに対する関連リソースおよびアクションへのHATEOSリンク。 リソースの正規表現へのリンクを含む自己リンクを少なくとも1つ含める必要があります。

  • ユーザー、クライアント・アプリケーションまたはグループの一意の名前。 メンバーがユーザーの場合、名前はユーザー名です。 メンバーがグループの場合、名前はグループ名です。

    リリース19.3.3.での導入。

  • メンバーがユーザー、クライアント・アプリケーションまたはグループであることを示します。

    有効な値は次のとおりです。

    • user - メンバーはユーザーまたはクライアント・アプリケーションです。 ユーザーまたはメンバー間で区別されません
    クライアント・アプリケーションであるメンバー。
    • group - メンバーはグループです

    リリース19.3.3.での導入。
  • user

    メンバーのユーザーまたはクライアント・アプリケーションの詳細。 メンバーのタイプがuserの場合にのみ使用できます。 メンバーは、ユーザー、クライアント・アプリケーションまたはグループにすることができます。 ユーザーとクライアント・アプリケーションの両方の詳細を読むことができます。

    リリース19.3.3.での導入。
ネストされたスキーマ : グループ

メンバーのグループ詳細。 メンバーのタイプが「グループ」の場合にのみ使用できます。

リリース19.3.3.での導入。
すべてに一致
ソースを表示
  • Group

    グループとは、ユーザーおよびグループの集合です。 グループには、ユーザーが読取り可能なグループ名があります。

    リリース19.3.1.での導入。
ネストされたスキーマ: links
型: array

このリソースに対する関連リソースおよびアクションへのHATEOSリンク。 リソースの正規表現へのリンクを含む自己リンクを少なくとも1つ含める必要があります。

ソースを表示
ネストされたスキーマ: user

メンバーのユーザーまたはクライアント・アプリケーションの詳細。 メンバーのタイプがuserの場合にのみ使用できます。 メンバーは、ユーザー、クライアント・アプリケーションまたはグループにすることができます。 ユーザーとクライアント・アプリケーションの両方の詳細を読むことができます。

リリース19.3.3.での導入。
すべてに一致
ソースを表示
  • 「アイデンティティ」
    識別子: type

    ユーザーまたはクライアント・アプリケーションを表すアイデンティティ。 アイデンティティには、アイデンティティ識別子、一意の名前、表示名などの共通情報が含まれます。

    リリース20.3.1で導入されました。
ネストされたスキーマ: Group

グループとは、ユーザーおよびグループの集合です。 グループには、ユーザーが読取り可能なグループ名があります。

リリース19.3.1.での導入。
すべてに一致
ソースを表示
  • SingularResource

    すべての単数形のリソースには、特異なリソース定義のプロパティが含まれます。 単一のリソースには、他のリソースとの関係を提供するリンク、またはリソース自体をselfがリンクするリンク先のリストが含まれます。

  • Group-allOf[1]
ネストされたスキーマ : SingularResource
型: object

すべての単数形のリソースには、特異なリソース定義のプロパティが含まれます。 単一のリソースには、他のリソースとの関係を提供するリンク、またはリソース自体をselfがリンクするリンク先のリストが含まれます。

ソースを表示
  • links
ネストされたスキーマ : Group-allOf[1]
型: object
ソースを表示

  • グループに対する、人間が読み取り可能な名前。

    リリース19.3.1.での導入。

  • サービス・インスタンス内で一意のグループ名。

    リリース19.3.1.での導入。

  • グループの一意の識別子。

    フィールドの内容は想定しないでください。フィールドはopaque値として扱われる必要があります。

    リリース19.3.1.での導入。
  • roles

    ロール

    有効な値は次のとおりです。

    • CECServiceAdministrator - サービス管理者
    • ユーザー列挙の割当
    • ユーザーのパスワードおよびチャレンジ質問の変更
    • サービス・インスタンスの構成、モニターおよび管理
    • CECSitesAdministrator - サイト管理者
    • サイト、テンプレート、テーマまたはコンポーネントの作成
    • CECRepositoryAdministrator - リポジトリ管理者
    • CECDeveloperUser - 開発者ユーザー
    • CECContentAdministrator - コンテンツ管理者
    • 新規コンテンツ・タイプの作成およびアイテムの公開
    • CECStandardUser - 標準ユーザー
    • コンテンツの管理(ドキュメントの表示、アップロードおよび編集)
    • 他のユーザーとのコンテンツおよびサイトの共有
    • 会話によるコラボレーション(トピックのディスカッション、他のユーザーへのメッセージの送信、他のユーザーへのフラグの割当て、ドキュメントへの注釈の追加)
    • ユーザーのフォロー
    • サイトの作成、編集および公開
    • サイトのテーマの管理および公開
    • カスタム・サイト・コンポーネントの作成、登録、エクスポートおよびインポート
    • サイト・テンプレートの作成、編集、エクスポートおよびインポート
    • サイト内のコンテンツの表示および操作
    • カスタム・プロパティの管理と表示、および値の編集
    • CECEnterpriseUser - エンタープライズ・ユーザー
    • コンテンツの管理(ドキュメントの表示、アップロードおよび編集)
    • 他のユーザーとのコンテンツおよびサイトの共有
    • 会話によるコラボレーション(トピックのディスカッション、他のユーザーへのメッセージの送信、他のユーザーへのフラグの割当て、ドキュメントへの注釈の追加)
    • ユーザーのフォロー
    • デジタル・アセット
    • コンテンツ・アイテム(エディトリアル・コンテンツ管理)
    • コンテンツ・アイテムの作成、管理、表示および操作
    • コレクション
    • サイトの作成、編集および公開
    • サイトのテーマの管理および公開
    • カスタム・サイト・コンポーネントの作成、登録、エクスポートおよびインポート
    • サイト・テンプレートの作成、編集、エクスポートおよびインポート
    • カスタム・プロパティの管理と表示、および値の編集
    • CECExternalUser - 外部ユーザー
    将来使用するために予約済
    • CECIntegrationUser - 統合ユーザー
    Collaboration REST APIのソーシャルRESTエンドポイントを介して操作を実行しながら、別のユーザーを偽装するために使用されます。
    • CECSitesVisitor - サイト・ビジター
    サイトへのアクセスはビジターに制限されます。

    リリース21.10.2で導入されました。

  • グループのタイプ。

    有効な値は次のとおりです。

    • oce - コンテンツ管理グループ
    • idp - アイデンティティ・プロバイダ・グループ

    リリース19.3.1.での導入。
ネストされたスキーマ: roles
型: array

ロール

有効な値は次のとおりです。

  • CECServiceAdministrator - サービス管理者
  • ユーザー列挙の割当
  • ユーザーのパスワードおよびチャレンジ質問の変更
  • サービス・インスタンスの構成、モニターおよび管理
  • CECSitesAdministrator - サイト管理者
  • サイト、テンプレート、テーマまたはコンポーネントの作成
  • CECRepositoryAdministrator - リポジトリ管理者
  • CECDeveloperUser - 開発者ユーザー
  • CECContentAdministrator - コンテンツ管理者
  • 新規コンテンツ・タイプの作成およびアイテムの公開
  • CECStandardUser - 標準ユーザー
  • コンテンツの管理(ドキュメントの表示、アップロードおよび編集)
  • 他のユーザーとのコンテンツおよびサイトの共有
  • 会話によるコラボレーション(トピックのディスカッション、他のユーザーへのメッセージの送信、他のユーザーへのフラグの割当て、ドキュメントへの注釈の追加)
  • ユーザーのフォロー
  • サイトの作成、編集および公開
  • サイトのテーマの管理および公開
  • カスタム・サイト・コンポーネントの作成、登録、エクスポートおよびインポート
  • サイト・テンプレートの作成、編集、エクスポートおよびインポート
  • サイト内のコンテンツの表示および操作
  • カスタム・プロパティの管理と表示、および値の編集
  • CECEnterpriseUser - エンタープライズ・ユーザー
  • コンテンツの管理(ドキュメントの表示、アップロードおよび編集)
  • 他のユーザーとのコンテンツおよびサイトの共有
  • 会話によるコラボレーション(トピックのディスカッション、他のユーザーへのメッセージの送信、他のユーザーへのフラグの割当て、ドキュメントへの注釈の追加)
  • ユーザーのフォロー
  • デジタル・アセット
  • コンテンツ・アイテム(エディトリアル・コンテンツ管理)
  • コンテンツ・アイテムの作成、管理、表示および操作
  • コレクション
  • サイトの作成、編集および公開
  • サイトのテーマの管理および公開
  • カスタム・サイト・コンポーネントの作成、登録、エクスポートおよびインポート
  • サイト・テンプレートの作成、編集、エクスポートおよびインポート
  • カスタム・プロパティの管理と表示、および値の編集
  • CECExternalUser - 外部ユーザー
将来使用するために予約済
  • CECIntegrationUser - 統合ユーザー
Collaboration REST APIのソーシャルRESTエンドポイントを介して操作を実行しながら、別のユーザーを偽装するために使用されます。
  • CECSitesVisitor - サイト・ビジター
サイトへのアクセスはビジターに制限されます。

リリース21.10.2で導入されました。
ソースを表示
ネストされたスキーマ: items
すべてに一致
ソースを表示
  • 「リンク」
ネストされたスキーマ: Identity
識別子: type

ユーザーまたはクライアント・アプリケーションを表すアイデンティティ。 アイデンティティには、アイデンティティ識別子、一意の名前、表示名などの共通情報が含まれます。

リリース20.3.1で導入されました。
すべてに一致
ソースを表示
  • SingularResource

    すべての単数形のリソースには、特異なリソース定義のプロパティが含まれます。 単一のリソースには、他のリソースとの関係を提供するリンク、またはリソース自体をselfがリンクするリンク先のリストが含まれます。

  • Identity-allOf[1]
ネストされたスキーマ : Identity-allOf[1]
型: object
ソースを表示

  • 人間が判読できる表示名。

    リリース20.3.1で導入されました。

  • ユーザーまたはクライアント・アプリケーションに対してCECによって割り当てられる識別子値。 識別子はサービスのスコープ内で一意です。

    フィールドの内容は想定しないでください。フィールドはopaque値として扱われる必要があります。

    リリース20.3.1で導入されました。

  • ユーザー名やクライアント・アプリケーション名などの一意の名前。

    リリース20.3.1で導入されました。
  • roles

    ロール

    有効な値は次のとおりです。

    • CECServiceAdministrator - サービス管理者
    • ユーザー列挙の割当
    • ユーザーのパスワードおよびチャレンジ質問の変更
    • サービス・インスタンスの構成、モニターおよび管理
    • CECSitesAdministrator - サイト管理者
    • サイト、テンプレート、テーマまたはコンポーネントの作成
    • CECRepositoryAdministrator - リポジトリ管理者
    • CECDeveloperUser - 開発者ユーザー
    • CECContentAdministrator - コンテンツ管理者
    • 新規コンテンツ・タイプの作成およびアイテムの公開
    • CECStandardUser - 標準ユーザー
    • コンテンツの管理(ドキュメントの表示、アップロードおよび編集)
    • 他のユーザーとのコンテンツおよびサイトの共有
    • 会話によるコラボレーション(トピックのディスカッション、他のユーザーへのメッセージの送信、他のユーザーへのフラグの割当て、ドキュメントへの注釈の追加)
    • ユーザーのフォロー
    • サイトの作成、編集および公開
    • サイトのテーマの管理および公開
    • カスタム・サイト・コンポーネントの作成、登録、エクスポートおよびインポート
    • サイト・テンプレートの作成、編集、エクスポートおよびインポート
    • サイト内のコンテンツの表示および操作
    • カスタム・プロパティの管理と表示、および値の編集
    • CECEnterpriseUser - エンタープライズ・ユーザー
    • コンテンツの管理(ドキュメントの表示、アップロードおよび編集)
    • 他のユーザーとのコンテンツおよびサイトの共有
    • 会話によるコラボレーション(トピックのディスカッション、他のユーザーへのメッセージの送信、他のユーザーへのフラグの割当て、ドキュメントへの注釈の追加)
    • ユーザーのフォロー
    • デジタル・アセット
    • コンテンツ・アイテム(エディトリアル・コンテンツ管理)
    • コンテンツ・アイテムの作成、管理、表示および操作
    • コレクション
    • サイトの作成、編集および公開
    • サイトのテーマの管理および公開
    • カスタム・サイト・コンポーネントの作成、登録、エクスポートおよびインポート
    • サイト・テンプレートの作成、編集、エクスポートおよびインポート
    • カスタム・プロパティの管理と表示、および値の編集
    • CECExternalUser - 外部ユーザー
    将来使用するために予約済
    • CECIntegrationUser - 統合ユーザー
    Collaboration REST APIのソーシャルRESTエンドポイントを介して操作を実行しながら、別のユーザーを偽装するために使用されます。
    • CECSitesVisitor - サイト・ビジター
    サイトへのアクセスはビジターに制限されます。

    リリース21.10.2で導入されました。

  • 「アイデンティティ」のタイプ。 有効な値は次のとおりです: user, service, application, unknown。

    リリース20.3.1で導入されました。
ネストされたスキーマ: roles
型: array

ロール

有効な値は次のとおりです。

  • CECServiceAdministrator - サービス管理者
  • ユーザー列挙の割当
  • ユーザーのパスワードおよびチャレンジ質問の変更
  • サービス・インスタンスの構成、モニターおよび管理
  • CECSitesAdministrator - サイト管理者
  • サイト、テンプレート、テーマまたはコンポーネントの作成
  • CECRepositoryAdministrator - リポジトリ管理者
  • CECDeveloperUser - 開発者ユーザー
  • CECContentAdministrator - コンテンツ管理者
  • 新規コンテンツ・タイプの作成およびアイテムの公開
  • CECStandardUser - 標準ユーザー
  • コンテンツの管理(ドキュメントの表示、アップロードおよび編集)
  • 他のユーザーとのコンテンツおよびサイトの共有
  • 会話によるコラボレーション(トピックのディスカッション、他のユーザーへのメッセージの送信、他のユーザーへのフラグの割当て、ドキュメントへの注釈の追加)
  • ユーザーのフォロー
  • サイトの作成、編集および公開
  • サイトのテーマの管理および公開
  • カスタム・サイト・コンポーネントの作成、登録、エクスポートおよびインポート
  • サイト・テンプレートの作成、編集、エクスポートおよびインポート
  • サイト内のコンテンツの表示および操作
  • カスタム・プロパティの管理と表示、および値の編集
  • CECEnterpriseUser - エンタープライズ・ユーザー
  • コンテンツの管理(ドキュメントの表示、アップロードおよび編集)
  • 他のユーザーとのコンテンツおよびサイトの共有
  • 会話によるコラボレーション(トピックのディスカッション、他のユーザーへのメッセージの送信、他のユーザーへのフラグの割当て、ドキュメントへの注釈の追加)
  • ユーザーのフォロー
  • デジタル・アセット
  • コンテンツ・アイテム(エディトリアル・コンテンツ管理)
  • コンテンツ・アイテムの作成、管理、表示および操作
  • コレクション
  • サイトの作成、編集および公開
  • サイトのテーマの管理および公開
  • カスタム・サイト・コンポーネントの作成、登録、エクスポートおよびインポート
  • サイト・テンプレートの作成、編集、エクスポートおよびインポート
  • カスタム・プロパティの管理と表示、および値の編集
  • CECExternalUser - 外部ユーザー
将来使用するために予約済
  • CECIntegrationUser - 統合ユーザー
Collaboration REST APIのソーシャルRESTエンドポイントを介して操作を実行しながら、別のユーザーを偽装するために使用されます。
  • CECSitesVisitor - サイト・ビジター
サイトへのアクセスはビジターに制限されます。

リリース21.10.2で導入されました。
ソースを表示
レスポンスの例 ()
{
    "id":"user:jsmith",
    "type":"user",
    "name":"jsmith",
    "displayName":"John Smith",
    "isExternalUser":false
}

400レスポンス

不正なリクエスト
本文()
ルート・スキーマ: schema
すべてに一致
ソースを表示
ネストされたスキーマ : InvalidIdentityExceptionDetail
リリース19.3.1.での導入。
すべてに一致
ソースを表示
  • ExceptionDetail

    HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。

  • InvalidIdentityExceptionDetail-allOf[1]
ネストされたスキーマ : ExceptionDetail
型: object

HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。

ソースを表示

  • この問題の発生に固有の説明。 人間が判読できる、場合によっては複数行の詳細で問題を説明しています。

  • エラーに関する詳細を提供するリンクへのURI。

  • アプリケーション・エラー・コード。HTTPエラー・コードとは異なります。 このコードは、titleやdetailなどのフィールドを比較するのではなく、特定のエラーをチェックするために使用する必要があります。

  • o:errorDetails

    階層構造に複数のエラーがある場合もあります。

  • エラーが発生した場所を示すXPathまたはJSONパス。

  • エラーに対応するHTTPステータス・コード。

  • 問題の短く、判読可能なサマリー。 タイトルは、特定のエラーをチェックする方法としては使用しないでください。そのためにはo:errorCodeを使用してください。

  • 問題のタイプを識別する絶対URI。 このURIが参照解除されると、「推奨」は、HTMLページなどの問題の判読可能なサマリーを提供します。

ネストされたスキーマ : InvalidIdentityExceptionDetail-allOf[1]
型: object
ソースを表示

  • 存在しないユーザーまたはアプリケーション。

    リリース19.3.1.での導入。
ネストされたスキーマ: o:errorDetails
型: array

階層構造に複数のエラーがある場合もあります。

ソースを表示
ネストされたスキーマ: items
すべてに一致
ソースを表示
  • 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レスポンス

見つかりません
ヘッダー
本文()
ルート・スキーマ: schema
すべてに一致
ソースを表示
ネストされたスキーマ : PolicyNotFoundExceptionDetail
すべてに一致
ソースを表示
  • ExceptionDetail

    HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。

  • PolicyNotFoundExceptionDetail-allOf[1]
ネストされたスキーマ : ExceptionDetail
型: object

HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。

ソースを表示

  • この問題の発生に固有の説明。 人間が判読できる、場合によっては複数行の詳細で問題を説明しています。

  • エラーに関する詳細を提供するリンクへのURI。

  • アプリケーション・エラー・コード。HTTPエラー・コードとは異なります。 このコードは、titleやdetailなどのフィールドを比較するのではなく、特定のエラーをチェックするために使用する必要があります。

  • o:errorDetails

    階層構造に複数のエラーがある場合もあります。

  • エラーが発生した場所を示すXPathまたはJSONパス。

  • エラーに対応するHTTPステータス・コード。

  • 問題の短く、判読可能なサマリー。 タイトルは、特定のエラーをチェックする方法としては使用しないでください。そのためにはo:errorCodeを使用してください。

  • 問題のタイプを識別する絶対URI。 このURIが参照解除されると、「推奨」は、HTMLページなどの問題の判読可能なサマリーを提供します。

ネストされたスキーマ : PolicyNotFoundExceptionDetail-allOf[1]
型: object
ソースを表示
ネストされたスキーマ: o:errorDetails
型: array

階層構造に複数のエラーがある場合もあります。

ソースを表示
ネストされたスキーマ: items
すべてに一致
ソースを表示
  • 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レスポンス

競合
本文()
ルート・スキーマ: schema
すべてに一致
ソースを表示
ネストされたスキーマ : PolicyReadOnlyExceptionDetail
すべてに一致
ソースを表示
  • ExceptionDetail

    HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。

  • PolicyReadOnlyExceptionDetail-allOf[1]
ネストされたスキーマ : ExceptionDetail
型: object

HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。

ソースを表示

  • この問題の発生に固有の説明。 人間が判読できる、場合によっては複数行の詳細で問題を説明しています。

  • エラーに関する詳細を提供するリンクへのURI。

  • アプリケーション・エラー・コード。HTTPエラー・コードとは異なります。 このコードは、titleやdetailなどのフィールドを比較するのではなく、特定のエラーをチェックするために使用する必要があります。

  • o:errorDetails

    階層構造に複数のエラーがある場合もあります。

  • エラーが発生した場所を示すXPathまたはJSONパス。

  • エラーに対応するHTTPステータス・コード。

  • 問題の短く、判読可能なサマリー。 タイトルは、特定のエラーをチェックする方法としては使用しないでください。そのためにはo:errorCodeを使用してください。

  • 問題のタイプを識別する絶対URI。 このURIが参照解除されると、「推奨」は、HTMLページなどの問題の判読可能なサマリーを提供します。

ネストされたスキーマ : PolicyReadOnlyExceptionDetail-allOf[1]
型: object
ソースを表示
ネストされたスキーマ: o:errorDetails
型: array

階層構造に複数のエラーがある場合もあります。

ソースを表示
ネストされたスキーマ: items
すべてに一致
ソースを表示
  • 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"
    }
}

413 レスポンス

ペイロードが大きすぎます

415 レスポンス

サポート対象外のメディア・タイプ

416 レスポンス

範囲を満たすことはできません

429 レスポンス

リクエストが多すぎます

500レスポンス

内部サーバー・エラー

501レスポンス

実装されていない

502 レスポンス

ゲートウェイが不良

503レスポンス

サービス使用不可

504レスポンス

ゲートウェイがタイムアウト
先頭に戻る