機械翻訳について

ポリシーとテンプレートの関連付け

post

/sites/management/api/v1/templates/{id}/policy

RELATION

ポリシーを作成してテンプレートに関連付けます。 サイト・ガバナンスが有効になっている場合、activeステータスを持つサイト作成ポリシーに関連付けられているテンプレートのみを使用してサイトを作成できます。 1つのテンプレートに関連付けることができるポリシーは1つのみです。 エンタープライズ・テンプレートに対してポリシーを作成する場合、サイト・プレフィクスの指定など、エンタープライズ・サイト関連のフィールドをポリシーに指定できます。 サイト・ガバナンスが無効になっている場合、テンプレートに関連付けられたポリシーは無視され、影響はありません。

認可

この操作を起動するには、認証されたユーザー・アプリケーションまたはクライアント・アプリケーションが次のいずれかのロールを持っている必要があります:

  • CECSitesAdministrator

ポリシー・アクセス・タイプの設定

ポリシーの作成時にアクセス・タイプを指定しなかった場合、アクセス・タイプはeveryoneにデフォルト設定されます。 restrictedアクセス・タイプでポリシーを指定すると、テンプレートにアクセスできるユーザー、アプリケーションまたはグループのセットがアクセス・リストを使用して追加されます。

詳細は、「アクセス・リストへのユーザー、アプリケーションまたはグループの追加」を参照してください。

テンプレートのポリシーの更新

テンプレートに関連付けられたポリシーは、ポリシー・リソースを使用して更新できます。

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

パス代替識別子

「テンプレート」リソースのデフォルトの識別子は、「テンプレート識別子」です。 テンプレート・リソースは代替識別子をサポートしています。

nameテンプレート名

テンプレート識別子のかわりに、テンプレート名を使用してリソース・パスでテンプレートを一意に識別できます。 テンプレートのデフォルトのリソース・パス・パラメータはテンプレート識別子ですが、テンプレートでの作業時には、判読可能なテンプレート名が簡単になる場合があります。

http://api.example.com/sites/management/api/v1/templates/name:CafeSupremo/policy

リリース19.4.1.での導入。

成功したレスポンスの例

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

201Created - Create an Automatic Approval Policy

承認なしでサイトを作成できる標準サイト・テンプレートにポリシーを関連付けます。 サイトがオンラインの場合、サイトではすべてのユーザーにアクセスが許可されます。

リクエスト

POST https://api.example.com/sites/management/api/v1/templates/{id}/policy

リクエスト本文

{
  "status": "active",
  "approvalType": "automatic",
  "accessType": "everyone",
  "security": {
    "level": "everyone",
    "appliesTo": "all"
  }
}

201作成日 - 管理者承認済ポリシーの作成

制限されたユーザーのみにサイトのリクエストを許可するエンタープライズ・サイト・テンプレートにポリシーを関連付けます。 サイトを作成する前に、サイト管理者がリクエストを承認する必要があります。 アセット・リポジトリはポリシーによっても固定されているため、ユーザーによる選択はできません。 サイト・プレフィクスおよびローカリゼーション・ポリシーは、ユーザーがサイトをリクエストしているため指定できません。 サイトがオンラインの場合、サイトではすべての認証済クラウド・ユーザーがアクセスできます。

リクエスト

POST https://api.example.com/sites/management/api/v1/templates/{id}/policy

リクエスト本文

{
  "status": "active",
  "approvalType": "admin",
  "accessType": "restricted",
  "security": {
    "level": "cloud",
    "appliesTo": "all"
  },
  "repository": "F81629473A3DB8B2A28669F19E68209BBAD3340745B0",
  "localizationPolicyAllowed": false,
  "sitePrefixAllowed": false
}

201作成日 - 名前付きユーザー承認済ポリシーの作成

ポリシーを標準テンプレートに関連付けます。このテンプレートからサイトを作成することはできず、後日アクティブ化できます。 ポリシーは、アクティブ化されると、誰でもサイトをリクエストできますが、ポリシー承認者リストに追加されたユーザーからの承認が必要です。

リクエスト

POST https://api.example.com/sites/management/api/v1/templates/{id}/policy

リクエスト本文

{
  "status": "inactive",
  "approvalType": "named",
  "accessType": "everyone",
  "security": {
    "level": "everyone",
    "appliesTo": "all"
  }
}
リリース19.3.3での導入。

201作成日 - サイト失効を含むポリシーの作成

サイトの有効期限を含む標準テンプレートにポリシーを関連付けます。 テンプレートからサイトが作成されると、有効期限が計算され、サイトに設定されます。

リクエスト

POST https://api.example.com/sites/management/api/v1/templates/{id}/policy

リクエスト本文

{
  "status": "inactive",
  "approvalType": "admin",
  "expiration": {
    "amount": 2,
    "unit": "years"
  }
}
リリース19.4.1で導入されました。

クライアント・エラー・レスポンスの例

この操作は、レスポンス本文に例外の詳細が含まれている次のクライアント・エラー(4xx)レスポンスで応答します。 レスポンスHTTPステータス・コードとサンプル本体の完全なリストは、この操作の「レスポンス」に関する項を参照してください。

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

400Bad Request - Invalid Security Scope

サイト・セキュリティ・スコープnamedは、everyoneのセキュリティ・レベルでは使用できません。 everyoneのセキュリティ・レベルを使用する場合は、allのサイト・セキュリティ・スコープを使用する必要があります。

エラー・コード

OCE-SITEMGMT-009018

解決 - サイト・セキュリティ・スコープの編集

セキュリティ・スコープを推奨される必須スコープ値に変更します。

例外詳細フィールド

このエラー・タイプでは、レスポンスに次のフィールド/値が含まれます:

フィールド名説明
level指定されたサイト・セキュリティ・レベル。 有効な値は次のとおりです。
  • service - サービス・ユーザーのみ
  • cloud - ドメインにサインインできるクラウド・ユーザーのみ
  • everyone - サインインせずに誰でも
specifiedScope指定したサイト・セキュリティ範囲。 有効な値は次のとおりです。
  • named - 指定されたレベル内の指定ユーザーのみがアクセスできます
  • all - 指定されたレベル内のすべてのユーザーがアクセスできます
requiredScope必須のサイト・セキュリティ・スコープです。 有効な値は次のとおりです。
  • named - 指定されたレベル内の指定ユーザーのみがアクセスできます
  • all - 指定されたレベル内のすべてのユーザーがアクセスできます

この例外の詳細タイプの詳細は、swaggerドキュメントの定義セクションのInvalidSecurityScopeExceptionDetailスキーマを参照してください。

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Invalid Security Scope",
  "status": "400",
  "detail": "Site security scope '{specifiedScope}' is not valid with a site security level of '{level}'. Use a security scope of '{requiredScope}'.",
  "o:errorCode": "OCE-SITEMGMT-009018",
  "level": "service",
  "specifiedScope": "named",
  "requiredScope": "all"
}

400Bad Request - Invalid Repository

参照されているリポジトリが見つかりませんでした。 リポジトリが存在しないか、削除されたか、認証されたユーザー・アプリケーションまたはクライアント・アプリケーションがリポジトリへのアクセス権を持っていません。

エラー・コード

OCE-CAAS-001006

解決 - 識別子のチェック

リポジトリ識別子が有効であることを確認してください。

解決 - メンバーシップのチェック

認証されたユーザーがリポジトリのメンバーであること、およびリポジトリに関連する操作を実行するための関連ロールを持っていることを確認してください。

例外詳細フィールド

このエラー・タイプでは、レスポンスに次のフィールド/値が含まれます:

フィールド名説明
repositoryリポジトリ識別子が指定されている場合、存在しない、または認証ユーザーに対して表示されないリポジトリ。

この例外の詳細タイプの詳細は、swaggerドキュメントの定義セクションのInvalidRepositoryExceptionDetailスキーマを参照してください。

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Invalid Repository",
  "status": "400",
  "detail": "Repository does not exist or has been deleted, or the authenticated user or client application does not have access to the repository.",
  "o:errorCode": "OCE-CAAS-001006",
  "repository": {
    "id": "F81629473A3DB8B2A28669F19E68209BBAD3340745B0"
  }
}

リリース19.2.3.での導入。

400Bad Request - Invalid Site Expiration

指定されたサイトの有効期限が小さすぎるか、大きすぎます。

エラー・コード

OCE-SITEMGMT-009067

解決 - 小さいサイトの有効期限の選択

小規模なサイト有効期限を指定します。

解決 - 大きなサイトの有効期限の選択

有効期間を長くしてください。

例外詳細フィールド

このエラー・タイプでは、レスポンスに次のフィールド/値が含まれます:

フィールド名説明
minimum最小サイト失効金額。
maximum最大サイト失効金額。

この例外の詳細タイプの詳細は、swaggerドキュメントの定義セクションのInvalidSiteExpirationExceptionDetailスキーマを参照してください。

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Invalid Site Expiration",
  "status": "400",
  "detail": "Site expiration must be set to between '{minimum.amount} {minimum.unit}' and '{maximum.amount} {maximum.unit}'.",
  "o:errorCode": "OCE-SITEMGMT-009067",
  "minimum": {
    "amount": "2",
    "unit": "months"
  },
  "maximum": {
    "amount": "2",
    "unit": "months"
  }
}

リリース19.4.1.での導入。

404Not Found - Template Not Found

サイト・テンプレートが存在しないか、削除されたか、認証済ユーザーまたはクライアント・アプリケーションがテンプレートへのアクセス権を持っていません。

エラー・コード

OCE-SITEMGMT-009000

解決 - 識別子のチェック

テンプレート識別子が有効であることを確認してください。

解決 - メンバーシップのチェック

認証済ユーザーがテンプレートのメンバーまたはサイト管理者であることを確認してください。

例外詳細フィールド

このエラー・タイプでは、レスポンスに次のフィールド/値が含まれます:

フィールド名説明
template存在しないか、認証されたユーザーに表示されないテンプレート。

この例外の詳細タイプの詳細は、swaggerドキュメントの定義セクションのTemplateNotFoundExceptionDetailスキーマを参照してください。

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Template Not Found",
  "status": "404",
  "detail": "Template does not exist or has been deleted, or the authenticated user or client application does not have access to the template.",
  "o:errorCode": "OCE-SITEMGMT-009000",
  "template": {
    "id": "F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6"
  }
}

404Not Found - Relationship Not Found

関係が存在しないため、関係を読み取ろうとしましたが失敗しました。 関係が存在しなくなった場合、または認証されたアイデンティティが関係の詳細の読取りを承認されていない場合に、関係の読取りが失敗する可能性があります。

エラー・コード

PAAS-005027

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Relationship Not Found",
  "status": "404",
  "detail": "Relationship resource not found. There is a relationship to a resource, but the resource at the end of the relationship does not exist, or the authenticated identity cannot see the resource.",
  "o:errorCode": "PAAS-005027"
}

409Conflict - Template Policy Already Exists

テンプレートは、1つのポリシー関連付けのみを持つことができます。

エラー・コード

OCE-SITEMGMT-009006

解決 - ポリシーの編集

ポリシーがすでにテンプレートに関連付けられている場合は、ポリシー・リソースのpatchメソッドを使用してポリシーを編集します。

解決 - ポリシーのリンク解除

テンプレート関係リソースを使用してポリシーをリンク解除してから、リクエストを再試行して必要なポリシーを作成してください。

例外詳細フィールド

このエラー・タイプでは、レスポンスに次のフィールド/値が含まれます:

フィールド名説明
policyテンプレートに関連付けられているポリシー。

この例外の詳細タイプの詳細は、swaggerドキュメントの定義セクションのTemplatePolicyAlreadyExistsExceptionDetailスキーマを参照してください。

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Template Policy Already Exists",
  "status": "409",
  "detail": "A policy has already been associated with this template.",
  "o:errorCode": "OCE-SITEMGMT-009006",
  "policy": {
    "id": "721af08b-32db-4eee-b6af-0c38d3ba4681"
  }
}

409Conflict - Template Deleted

ソフト削除テンプレートでは操作を実行できません。 このエラーは、includeDeleted問合せパラメータがtrueに設定されている場合にのみ発生

エラー・コード

OCE-SITEMGMT-009061

解決 - テンプレートのリストア

テンプレートをリストアしてから操作を再試行してください。

例外詳細フィールド

このエラー・タイプでは、レスポンスに次のフィールド/値が含まれます:

フィールド名説明
templateソフト削除されるテンプレート。

この例外の詳細タイプの詳細は、swaggerドキュメントの定義セクションのTemplateDeletedExceptionDetailスキーマを参照してください。

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Template Deleted",
  "status": "409",
  "detail": "The operation cannot be performed as the template has been soft deleted.",
  "o:errorCode": "OCE-SITEMGMT-009061",
  "template": {
    "id": "F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6"
  }
}

リリース19.4.1.での導入。

409Conflict - Missing Template Localization Policy

関連付けられたエンタープライズ・サイト・テンプレートにはデフォルトのローカリゼーション・ポリシーがないため、このポリシーでユーザーはローカリゼーション・ポリシーを指定できる必要があります。

テンプレートに関連付けられているローカリゼーション・ポリシーが削除された場合も、このエラーが発生します。 テンプレート・ローカリゼーション・ポリシーが欠落している場合、関連付けられたポリシーがテンプレートのローカリゼーション・ポリシーを使用することを指定する場所でサイト・リクエストが完了しないようにします。

エラー・コード

OCE-SITEMGMT-009030

解決 - ローカリゼーション・ポリシーの更新

テンプレート・ポリシーを変更して、リクエストしているユーザーがローカリゼーション・ポリシーを指定できるようにします。

例外詳細フィールド

このエラー・タイプでは、レスポンスに次のフィールド/値が含まれます:

フィールド名説明
templateローカリゼーション・ポリシーがないテンプレート。

この例外の詳細タイプの詳細は、swaggerドキュメントの定義セクションのMissingTemplateLocalizationPolicyExceptionDetailスキーマを参照してください。

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Missing Template Localization Policy",
  "status": "409",
  "detail": "The template does not have a localization policy, or the localization policy associated with the template has been deleted.",
  "o:errorCode": "OCE-SITEMGMT-009030",
  "template": {
    "id": "F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6"
  }
}

このリソースは、テンプレートとポリシー・リソース間の関係を表します。 テンプレートに関連付けられているポリシーがない場合、レスポンス・ステータス・コードは204 No Contentになります。 ポリシーが削除されているか、認証されたユーザーがリソースの読取りを認可されていない場合、レスポンス・ステータス・コードは「404見つかりません」になり、レスポンス本文に「関係が見つかりません」エラーが返されます。

リクエスト

サポートされているメディア・タイプ
パス・パラメータ
問合せパラメータ
  • 削除対象としてマークされているリソースでは、この問合せパラメータがtrueに設定されているかぎり、読取り、変更およびサポート対象の拡張操作が可能です。 includeDeleted問合せパラメータを送信しない場合、読取り、変更および拡張操作に対するレスポンスは、リソースが完全に削除された場合に戻されるものと同じです。

本文()

テンプレートに関連付けるポリシーの詳細。

ルート・スキーマ: schema
型: object
ソースを表示
  • ポリシーをすべてのユーザーに適用するか、アクセス・リストに含まれるユーザーにのみ適用するかを決定します。

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

    • everyone - ポリシー(アクティブな場合)は全員に適用されます
    • restricted - ポリシーは、アクティブな場合、アクセス・リストに含まれるユーザーに適用可能です

    リリース19.3.1.での導入。
  • このポリシーに関連付けられたリクエストが作成される場合、そのリクエストにはポリシーで定義された承認のタイプが必要です。 承認のタイプが自動の場合、リクエストには手動での承認は必要ありません。

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

    • automatic - リクエストは、ユーザーの承認プロセスなしで自動的に承認されます
    • admin - 「サイト管理者」のロールを持つユーザーは、関連するリクエストを承認できます。
    • named - サイトの作成では、ポリシーに関連付けられた承認者リストのメンバーであるユーザーの承認が必要です

  • 有効期限

    サイトが作成されたとき、サイト・テンプレートに関連付けられたポリシーにサイト有効期限が設定されている場合、有効期限をサイトに設定できます。 サイトの有効期限が切れている場合、有効期限が延長されないかぎりサイトをアクティブ化できません。

    リリース19.4.1.での導入。
  • links

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

  • ローカリゼーション・ポリシーが許可されていない場合、リクエスタはサイトのリクエスト時にローカリゼーション・ポリシーの指定を許可されません。 テンプレートに関連付けられているローカリゼーション・ポリシーが使用されます。 ローカリゼーション・ポリシーが許可されている場合、リクエスタはサイトのリクエスト時に1つ指定する必要があります。 このプロパティは、ポリシーに関連付けられているテンプレートがエンタープライズ・テンプレートの場合にのみ設定できます。

    リリース19.2.3.での導入。
  • ポリシーを作成または編集する場合、そのポリシーをアセット・リポジトリに関連付けることができます。 新規サイトがリクエストされると、サイトはポリシー定義済アセット・リポジトリに関連付けられます。 リポジトリがポリシーに設定されている場合、ユーザーは新規サイトの作成時にリポジトリを指定できません。 ポリシーに関連付けられたアセット・リポジトリがない場合、ユーザーが新規サイトを作成するときにアセット・リポジトリを指定できます。 アセット・リポジトリは、ポリシーがエンタープライズ・テンプレートに関連付けられている場合にのみポリシーに関連付けることができます。 Standardサイトはアセット・リポジトリに関連付けられません。

    リリース19.2.3.での導入。
  • security

    サイト作成ポリシーのセキュリティ・ポリシー。 セキュリティ・ポリシーでは、サイトに許可される最小限のセキュリティ・レベルを指定します。

  • trueの場合、新規サイトに対するリクエストには、明示的なサイト・プレフィクスを含めることができます。 falseの場合、サイト・プレフィクスを指定しないと、自動的に生成されます。 このプロパティは、ポリシーに関連付けられているテンプレートがエンタープライズ・テンプレートの場合にのみ設定できます。

    リリース19.2.3.での導入。
  • ポリシー・ステータスは、ポリシーに関連付けられた操作の実行にポリシーを使用できるかどうかを指定します。 ポリシー・ステータスがinactiveの場合、操作は実行できません。 ポリシー・ステータスが「アクティブ」の場合は、操作を実行できます。 たとえば、サイト・テンプレートに関連付けられたポリシーの場合、「アクティブ」のステータスは、ユーザーがサイト・テンプレートからサイトを作成できることを意味します。

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

    • inactive - 非アクティブとしてマークされているポリシーは、関連する操作をリクエストできないことを意味
    • active - アクティブとしてマークされているポリシーは、関連する操作がリクエスト可能であることを意味

例:
{
    "status":"active",
    "approvalType":"automatic",
    "accessType":"everyone",
    "security":{
        "level":"everyone",
        "appliesTo":"all"
    }
}
ネストされたスキーマ : 有効期限

サイトが作成されたとき、サイト・テンプレートに関連付けられたポリシーにサイト有効期限が設定されている場合、有効期限をサイトに設定できます。 サイトの有効期限が切れている場合、有効期限が延長されないかぎりサイトをアクティブ化できません。

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

    サイトの有効期限は、時間と時間の単位で表されます。 たとえば、サイトが作成された後、2か月後にサイトを失効させます。

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

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

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

サイト作成ポリシーのセキュリティ・ポリシー。 セキュリティ・ポリシーでは、サイトに許可される最小限のセキュリティ・レベルを指定します。

すべてに一致
ソースを表示
  • SecurityPolicy

    セキュリティ・ポリシーでは、サイトに許可されるセキュリティ・レベルの最小レベルを指定します。 サイトはこの最小レベルで作成されます。サイト・マネージャ/所有者は必要に応じてサイトでより制限的なセキュリティ・レベルを設定できます。 マネージャ/所有者は、サイト・セキュリティ・ポリシーで指定された値よりも安全性が低いセキュリティ・レベルは選択できません。

ネストされたスキーマ : SiteExpirationPeriod
型: object

サイトの有効期限は、時間と時間の単位で表されます。 たとえば、サイトが作成された後、2か月後にサイトを失効させます。

リリース19.4.1.での導入。
ソースを表示
  • サイト失効の測定に使用する期間。

    リリース19.4.1.での導入。
  • サイト失効の測定に使用する時間の単位。

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

    • months - 失効は月数で表されます
    • years - 失効までの年数

    リリース19.4.1.での導入。
ネストされたスキーマ: items
すべてに一致
ソースを表示
  • 「リンク」
ネストされたスキーマ : SecurityPolicy
型: object

セキュリティ・ポリシーでは、サイトに許可されるセキュリティ・レベルの最小レベルを指定します。 サイトはこの最小レベルで作成されます。サイト・マネージャ/所有者は必要に応じてサイトでより制限的なセキュリティ・レベルを設定できます。 マネージャ/所有者は、サイト・セキュリティ・ポリシーで指定された値よりも安全性が低いセキュリティ・レベルは選択できません。

ソースを表示
  • サイトにアクセス可能なユーザーのタイプを定義します。 すべてのユーザーを含めることも、指定ユーザーのみに制限することもできます。

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

    • named - 指定されたレベル内の指定ユーザーのみがアクセスできます
    • all - 指定されたレベル内のすべてのユーザーがアクセスできます

  • サイトに設定できる最大オープン・セキュリティ・レベル。

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

    • service - サービス・ユーザーのみ
    • cloud - ドメインにサインインできるクラウド・ユーザーのみ
    • everyone - サインインせずに誰でも

トップに戻る

レスポンス

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

201レスポンス

作成日
ヘッダー
本文()
ルート・スキーマ: schema
すべてに一致
ソースを表示
  • Policy

    ポリシーは、サイト関連の操作を実行するリクエストの承認方法と、その操作を実行する際に適用する特定の制限またはデフォルトがあるかどうかを制御します。

    ポリシーはリソースに関連付けられています。たとえば、「サイト作成」ポリシーはサイト・テンプレートに関連付けることができます。 たとえば、サイト作成ポリシーでは、サイト管理者の承認が特定のサイト・テンプレートからのサイトの作成に必要であり、そのサイト・テンプレートのドメイン・ユーザーのセキュリティ・レベルのみが割り当てられることを指定できます。

    ポリシーはinactiveとしてマークできます。これにより、操作の実行またはリクエストを防止できます。

ネストされたスキーマ: Policy

ポリシーは、サイト関連の操作を実行するリクエストの承認方法と、その操作を実行する際に適用する特定の制限またはデフォルトがあるかどうかを制御します。

ポリシーはリソースに関連付けられています。たとえば、「サイト作成」ポリシーはサイト・テンプレートに関連付けることができます。 たとえば、サイト作成ポリシーでは、サイト管理者の承認が特定のサイト・テンプレートからのサイトの作成に必要であり、そのサイト・テンプレートのドメイン・ユーザーのセキュリティ・レベルのみが割り当てられることを指定できます。

ポリシーはinactiveとしてマークできます。これにより、操作の実行またはリクエストを防止できます。

すべてに一致
ソースを表示
  • SingularResource

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

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

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

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

    ポリシーに関連付けられた操作を実行できるユーザーおよびグループのリスト。 たとえば、テンプレートからサイトを作成できるユーザーおよびグループのリストです。 アクセス・リストが空の場合、すべてのユーザーがポリシー操作を実行できます。 アクセス・リストは、ポリシーのaccessTyperestrictedに設定されている場合にのみ使用されます。

    リリース19.3.1.での導入。
  • ポリシーをすべてのユーザーに適用するか、アクセス・リストに含まれるユーザーにのみ適用するかを決定します。

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

    • everyone - ポリシー(アクティブな場合)は全員に適用されます
    • restricted - ポリシーは、アクティブな場合、アクセス・リストに含まれるユーザーに適用可能です

    リリース19.3.1.での導入。
  • このポリシーに関連付けられたリクエストが作成される場合、そのリクエストにはポリシーで定義された承認のタイプが必要です。 承認のタイプが自動の場合、リクエストには手動での承認は必要ありません。

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

    • automatic - リクエストは、ユーザーの承認プロセスなしで自動的に承認されます
    • admin - 「サイト管理者」のロールを持つユーザーは、関連するリクエストを承認できます。
    • named - サイトの作成では、ポリシーに関連付けられた承認者リストのメンバーであるユーザーの承認が必要です

  • approvers

    ポリシーに関連付けられたリクエストを承認する権限を持つユーザーおよびグループのリスト。 たとえば、テンプレートからのサイトの作成を承認できるユーザーおよびグループのリストです。 承認リストは、承認タイプが「指定された承認者」に設定されている場合にのみ使用されます。

    リリース19.3.3.での導入。
  • 有効期限

    サイトが作成されたとき、サイト・テンプレートに関連付けられたポリシーにサイト有効期限が設定されている場合、有効期限をサイトに設定できます。 サイトの有効期限が切れている場合、有効期限が延長されないかぎりサイトをアクティブ化できません。

    リリース19.4.1.での導入。
  • ポリシーのグローバル一意識別子。

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

  • ローカリゼーション・ポリシーが許可されていない場合、リクエスタはサイトのリクエスト時にローカリゼーション・ポリシーの指定を許可されません。 テンプレートに関連付けられているローカリゼーション・ポリシーが使用されます。 ローカリゼーション・ポリシーが許可されている場合、リクエスタはサイトのリクエスト時に1つ指定する必要があります。 このプロパティは、ポリシーに関連付けられているテンプレートがエンタープライズ・テンプレートの場合にのみ設定できます。

    リリース19.2.3.での導入。
  • repository

    ポリシーを作成または編集する場合、そのポリシーをアセット・リポジトリに関連付けることができます。 新規サイトがリクエストされると、サイトはポリシー定義済アセット・リポジトリに関連付けられます。 リポジトリがポリシーに設定されている場合、ユーザーは新規サイトの作成時にリポジトリを指定できません。 ポリシーに関連付けられたアセット・リポジトリがない場合、ユーザーが新規サイトを作成するときにアセット・リポジトリを指定できます。 アセット・リポジトリは、ポリシーがエンタープライズ・テンプレートに関連付けられている場合にのみポリシーに関連付けることができます。 Standardサイトはアセット・リポジトリに関連付けられません。

    リリース19.2.3.での導入。
  • ポリシーが編集されるたびに、リビジョン番号が増分されます。 改訂番号はゼロから開始します。 リビジョン番号は、リビジョンがこのリソースの強力なETag値としても使用されるため、最後のリクエスト以降にポリシーが変更されたかどうかを確認するために使用できます。

  • security

    サイト作成ポリシーのセキュリティ・ポリシー。 セキュリティ・ポリシーでは、サイトに許可される最小限のセキュリティ・レベルを指定します。

  • trueの場合、新規サイトに対するリクエストには、明示的なサイト・プレフィクスを含めることができます。 falseの場合、サイト・プレフィクスを指定しないと、自動的に生成されます。 このプロパティは、ポリシーに関連付けられているテンプレートがエンタープライズ・テンプレートの場合にのみ設定できます。

    リリース19.2.3.での導入。
  • ポリシー・ステータスは、ポリシーに関連付けられた操作の実行にポリシーを使用できるかどうかを指定します。 ポリシー・ステータスがinactiveの場合、操作は実行できません。 ポリシー・ステータスが「アクティブ」の場合は、操作を実行できます。 たとえば、サイト・テンプレートに関連付けられたポリシーの場合、「アクティブ」のステータスは、ユーザーがサイト・テンプレートからサイトを作成できることを意味します。

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

    • inactive - 非アクティブとしてマークされているポリシーは、関連する操作をリクエストできないことを意味
    • active - アクティブとしてマークされているポリシーは、関連する操作がリクエスト可能であることを意味

ネストされたスキーマ : アクセス
型: object

ポリシーに関連付けられた操作を実行できるユーザーおよびグループのリスト。 たとえば、テンプレートからサイトを作成できるユーザーおよびグループのリストです。 アクセス・リストが空の場合、すべてのユーザーがポリシー操作を実行できます。 アクセス・リストは、ポリシーのaccessTyperestrictedに設定されている場合にのみ使用されます。

リリース19.3.1.での導入。
ソースを表示
  • items

    「ポリシー・アクセス・メンバー」要素のコレクション。

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

    REST APIによって返されるすべてのコレクションは、標準のコレクション定義を拡張します。 この定義では、品目の合計数、返される品目のオフセットおよび制限の詳細、品目の数、および使用可能な品目が他にもあるかどうかを示すインジケータに関する情報を提供します。

ネストされたスキーマ : 承認者
型: object

ポリシーに関連付けられたリクエストを承認する権限を持つユーザーおよびグループのリスト。 たとえば、テンプレートからのサイトの作成を承認できるユーザーおよびグループのリストです。 承認リストは、承認タイプが「指定された承認者」に設定されている場合にのみ使用されます。

リリース19.3.3.での導入。
ソースを表示
  • items

    「ポリシー承認者メンバー」要素のコレクション。

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

    REST APIによって返されるすべてのコレクションは、標準のコレクション定義を拡張します。 この定義では、品目の合計数、返される品目のオフセットおよび制限の詳細、品目の数、および使用可能な品目が他にもあるかどうかを示すインジケータに関する情報を提供します。

ネストされたスキーマ : 有効期限

サイトが作成されたとき、サイト・テンプレートに関連付けられたポリシーにサイト有効期限が設定されている場合、有効期限をサイトに設定できます。 サイトの有効期限が切れている場合、有効期限が延長されないかぎりサイトをアクティブ化できません。

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

    サイトの有効期限は、時間と時間の単位で表されます。 たとえば、サイトが作成された後、2か月後にサイトを失効させます。

    リリース19.4.1.での導入。
ネストされたスキーマ : repository

ポリシーを作成または編集する場合、そのポリシーをアセット・リポジトリに関連付けることができます。 新規サイトがリクエストされると、サイトはポリシー定義済アセット・リポジトリに関連付けられます。 リポジトリがポリシーに設定されている場合、ユーザーは新規サイトの作成時にリポジトリを指定できません。 ポリシーに関連付けられたアセット・リポジトリがない場合、ユーザーが新規サイトを作成するときにアセット・リポジトリを指定できます。 アセット・リポジトリは、ポリシーがエンタープライズ・テンプレートに関連付けられている場合にのみポリシーに関連付けることができます。 Standardサイトはアセット・リポジトリに関連付けられません。

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

    リポジトリは、テキストとイメージの両方のファイルのストレージ・ロケーションです。 リポジトリ管理者は、リポジトリに対して指定されたチャネル・ポリシーおよびローカリゼーション・ポリシーを使用してリポジトリを作成できます。 様々なマーケティング・ニーズに対応するために、複数のリポジトリを作成できます。

    リポジトリを使用すると、必要なすべてのアセットを1箇所で管理できます。 たとえば、会社でコンピュータ機器を販売するとします。 デスクトップ・コンピュータに関連するファイルを処理するために、1つのリポジトリを設定できます。 タブレットには別のリポジトリを使用できます。 各リポジトリには、様々な種類のコンピュータに関する写真、グラフィックおよびコンテンツを含めることができます。 各リポジトリのアセットは、リポジトリに割り当てるポリシーによって制御されます。

ネストされたスキーマ: security

サイト作成ポリシーのセキュリティ・ポリシー。 セキュリティ・ポリシーでは、サイトに許可される最小限のセキュリティ・レベルを指定します。

すべてに一致
ソースを表示
  • SecurityPolicy

    セキュリティ・ポリシーでは、サイトに許可されるセキュリティ・レベルの最小レベルを指定します。 サイトはこの最小レベルで作成されます。サイト・マネージャ/所有者は必要に応じてサイトでより制限的なセキュリティ・レベルを設定できます。 マネージャ/所有者は、サイト・セキュリティ・ポリシーで指定された値よりも安全性が低いセキュリティ・レベルは選択できません。

ネストされたスキーマ: items
型: array

「ポリシー・アクセス・メンバー」要素のコレクション。

リリース19.3.1.での導入。
ソースを表示
ネストされたスキーマ : CollectionResource

REST APIによって返されるすべてのコレクションは、標準のコレクション定義を拡張します。 この定義では、品目の合計数、返される品目のオフセットおよび制限の詳細、品目の数、および使用可能な品目が他にもあるかどうかを示すインジケータに関する情報を提供します。

すべてに一致
ソースを表示
  • SingularResource

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

  • CollectionResource-allOf[1]
ネストされたスキーマ : CollectionResource-allOf[1]
型: object
ソースを表示
  • レスポンス内のリソースの合計数。

  • コレクションには、リクエストに一致する多くの要素があります。 ページ・リクエストを作成し、ページがすべての要素を返すのに十分な大きさでない場合に、返されるアイテムが他にもあるかどうかを示します。

  • 実際のレスポンス・サイズ制限。 リクエストで指定されている制限値が大きすぎる場合、または制限が指定されていない場合、レスポンスでは使用される制限が指定されます。

  • 使用される実際のレスポンス・オフセット。 リクエストでオフセットが指定されていない場合、レスポンスに実際のオフセットが指定されます。

  • リクエストに一致するリソースの合計数。 指定した場合は、使用可能なアイテムの合計数です。 指定されない場合、合計が不明か、または戻り不可能です。 この値を計算するとき、ページング制限またはオフセットは無視されます。 totalResultsパラメータがサポートされていて、クライアントがtrueに設定している場合にのみ返されます。

ネストされたスキーマ: items
型: object
ソースを表示
  • ユーザー、クライアント・アプリケーションまたはグループの表示名。

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

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

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

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

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

    リリース20.1.1で導入されました。
  • ユーザー、クライアント・アプリケーションまたはグループ・メンバーの識別子。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  • Group-allOf[1]
ネストされたスキーマ : 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で導入されました。
ソースを表示
ネストされたスキーマ: 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で導入されました。
ソースを表示
ネストされたスキーマ: items
型: array

「ポリシー承認者メンバー」要素のコレクション。

リリース19.3.3.での導入。
ソースを表示
ネストされたスキーマ: items
型: object
ソースを表示
  • ユーザー、クライアント・アプリケーションまたはグループの表示名。

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

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

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

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

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

    リリース20.1.1で導入されました。
  • ユーザー、クライアント・アプリケーションまたはグループ・メンバーの識別子。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

サイトの有効期限は、時間と時間の単位で表されます。 たとえば、サイトが作成された後、2か月後にサイトを失効させます。

リリース19.4.1.での導入。
ソースを表示
  • サイト失効の測定に使用する期間。

    リリース19.4.1.での導入。
  • サイト失効の測定に使用する時間の単位。

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

    • months - 失効は月数で表されます
    • years - 失効までの年数

    リリース19.4.1.での導入。
ネストされたスキーマ : リポジトリ

リポジトリは、テキストとイメージの両方のファイルのストレージ・ロケーションです。 リポジトリ管理者は、リポジトリに対して指定されたチャネル・ポリシーおよびローカリゼーション・ポリシーを使用してリポジトリを作成できます。 様々なマーケティング・ニーズに対応するために、複数のリポジトリを作成できます。

リポジトリを使用すると、必要なすべてのアセットを1箇所で管理できます。 たとえば、会社でコンピュータ機器を販売するとします。 デスクトップ・コンピュータに関連するファイルを処理するために、1つのリポジトリを設定できます。 タブレットには別のリポジトリを使用できます。 各リポジトリには、様々な種類のコンピュータに関する写真、グラフィックおよびコンテンツを含めることができます。 各リポジトリのアセットは、リポジトリに割り当てるポリシーによって制御されます。

すべてに一致
ソースを表示
  • SingularResource

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

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

リポジトリに関連付けられているチャネル。

ソースを表示
ネストされたスキーマ : contentTypes
型: array

リポジトリに関連付けられたコンテンツ・タイプ。

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

リポジトリの作成日時。

すべてに一致
ソースを表示
ネストされたスキーマ : languageOptions
型: array

リポジトリの言語オプション。

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

リポジトリが最後に更新された日時。

すべてに一致
ソースを表示
ネストされたスキーマ: items
すべてに一致
ソースを表示
ネストされたスキーマ : ChannelId
型: object

チャネル識別子。

ソースを表示
  • リポジトリの一意の識別子。

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

  • チャネルを識別するための短くて判読可能な名前。

ネストされたスキーマ: items
すべてに一致
ソースを表示
ネストされたスキーマ : ContentTypeId
型: object

コンテンツ・タイプ識別子。

ソースを表示
ネストされたスキーマ : DateTimeZone
型: object

日付、時間およびタイムゾーン。

ソースを表示
ネストされたスキーマ : SecurityPolicy
型: object

セキュリティ・ポリシーでは、サイトに許可されるセキュリティ・レベルの最小レベルを指定します。 サイトはこの最小レベルで作成されます。サイト・マネージャ/所有者は必要に応じてサイトでより制限的なセキュリティ・レベルを設定できます。 マネージャ/所有者は、サイト・セキュリティ・ポリシーで指定された値よりも安全性が低いセキュリティ・レベルは選択できません。

ソースを表示
  • サイトにアクセス可能なユーザーのタイプを定義します。 すべてのユーザーを含めることも、指定ユーザーのみに制限することもできます。

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

    • named - 指定されたレベル内の指定ユーザーのみがアクセスできます
    • all - 指定されたレベル内のすべてのユーザーがアクセスできます

  • サイトに設定できる最大オープン・セキュリティ・レベル。

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

    • service - サービス・ユーザーのみ
    • cloud - ドメインにサインインできるクラウド・ユーザーのみ
    • everyone - サインインせずに誰でも

レスポンスの例 ()
{
    "id":"721af08b-32db-4eee-b6af-0c38d3ba4681",
    "status":"inactive",
    "approvalType":"automatic",
    "accessType":"everyone",
    "security":{
        "level":"service",
        "appliesTo":"named"
    },
    "localizationPolicyAllowed":false,
    "sitePrefixAllowed":false,
    "expiration":{
        "amount":"2",
        "unit":"months"
    },
    "revision":"0"
}

400レスポンス

不正なリクエスト
本文()
ルート・スキーマ: schema
すべてに一致
ソースを表示
ネストされたスキーマ : UnsupportedPolicyFieldExceptionDetail
すべてに一致
ソースを表示
ネストされたスキーマ : ExceptionDetail
型: object

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

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

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

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

  • o:errorDetails

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

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

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

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

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

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

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

ソースを表示
ネストされたスキーマ: items
すべてに一致
ソースを表示
  • ExceptionDetail

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

レスポンスの例(サポートされないポリシー・フィールド)
{
    "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"
}
レスポンスの例(無効なセキュリティ・スコープ)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Invalid Security Scope",
    "status":"400",
    "detail":"Site security scope '{specifiedScope}' is not valid with a site security level of '{level}'. Use a security scope of '{requiredScope}'.",
    "o:errorCode":"OCE-SITEMGMT-009018",
    "level":"service",
    "specifiedScope":"named",
    "requiredScope":"all"
}
レスポンスの例(無効なリポジトリ)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Invalid Repository",
    "status":"400",
    "detail":"Repository does not exist or has been deleted, or the authenticated user or client application does not have access to the repository.",
    "o:errorCode":"OCE-CAAS-001006",
    "repository":{
        "id":"F81629473A3DB8B2A28669F19E68209BBAD3340745B0"
    }
}
レスポンスの例(無効なサイトの有効期限)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Invalid Site Expiration",
    "status":"400",
    "detail":"Site expiration must be set to between '{minimum.amount} {minimum.unit}' and '{maximum.amount} {maximum.unit}'.",
    "o:errorCode":"OCE-SITEMGMT-009067",
    "minimum":{
        "amount":"2",
        "unit":"months"
    },
    "maximum":{
        "amount":"2",
        "unit":"months"
    }
}

401レスポンス

未認可

403レスポンス

禁止

404レスポンス

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

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

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

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

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

  • o:errorDetails

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

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

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

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

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

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

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

ソースを表示
ネストされたスキーマ: items
すべてに一致
ソースを表示
  • ExceptionDetail

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

レスポンスの例(テンプレートが見つかりません)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Template Not Found",
    "status":"404",
    "detail":"Template does not exist or has been deleted, or the authenticated user or client application does not have access to the template.",
    "o:errorCode":"OCE-SITEMGMT-009000",
    "template":{
        "id":"F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6"
    }
}
レスポンスの例 (関係が見つかりません)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Relationship Not Found",
    "status":"404",
    "detail":"Relationship resource not found. There is a relationship to a resource, but the resource at the end of the relationship does not exist, or the authenticated identity cannot see the resource.",
    "o:errorCode":"PAAS-005027"
}

406レスポンス

受入れられない

409レスポンス

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

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

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

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

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

  • o:errorDetails

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

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

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

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

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

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

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

ソースを表示
ネストされたスキーマ: items
すべてに一致
ソースを表示
  • ExceptionDetail

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

レスポンスの例(テンプレート・ポリシーがすでに存在します)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Template Policy Already Exists",
    "status":"409",
    "detail":"A policy has already been associated with this template.",
    "o:errorCode":"OCE-SITEMGMT-009006",
    "policy":{
        "id":"721af08b-32db-4eee-b6af-0c38d3ba4681"
    }
}
レスポンスの例(テンプレートの削除)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Template Deleted",
    "status":"409",
    "detail":"The operation cannot be performed as the template has been soft deleted.",
    "o:errorCode":"OCE-SITEMGMT-009061",
    "template":{
        "id":"F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6"
    }
}
レスポンスの例(テンプレート・ローカリゼーション・ポリシーがありません)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Missing Template Localization Policy",
    "status":"409",
    "detail":"The template does not have a localization policy, or the localization policy associated with the template has been deleted.",
    "o:errorCode":"OCE-SITEMGMT-009030",
    "template":{
        "id":"F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6"
    }
}

413 レスポンス

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

415 レスポンス

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

416 レスポンス

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

429 レスポンス

リクエストが多すぎます

500レスポンス

内部サーバー・エラー

501レスポンス

実装されていない

502 レスポンス

ゲートウェイが不良

503レスポンス

サービス使用不可

504レスポンス

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