サイト管理用のREST API

機械翻訳について

サイト管理設定の取得

get

/sites/management/api/v1/settings

SINGULAR

サイト、テンプレート、テーマおよびコンポーネントを作成できるユーザーの制御、サイト・ガバナンスの有効化、サイト事前レンダー・サービスが有効かどうかの制御など、サービス全体のサイト管理関連の設定を提供します。

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

成功したレスポンスの例

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

200OK

リクエスト

GET https://api.example.com/sites/management/api/v1/settings

レスポンス本文

{
  "allowSiteCreation": false,
  "governanceEnabled": false,
  "siteSecurityPolicy": {
    "level": "service",
    "appliesTo": "named"
  },
  "siteAdminOnlyOperations": {
    "siteCreation": false,
    "templateCreation": false,
    "themeCreation": false,
    "componentCreation": false
  },
  "prerender": {
    "enabled": false,
    "userAgents": "AdsBot-Google,AdsBot-Google-Mobile-Apps,AppEngine-Google"
  },
  "expiration": {
    "action": "nothing",
    "deleteAfter": 30
  }
}

リクエスト

問合せパラメータ

excludeFields(optional): string

レスポンスに含めないフィールド名のカンマ区切り文字列。
excludeLinks(optional): string

レスポンスからexcludeへのリンク関係名のカンマ区切りリスト。
fields(optional): string

レスポンスに含めるフィールド名のカンマ区切りの文字列。フィールド名を区切るには、ドットを使用してネストされたフィールドを特定できます。フィールド名は大文字と小文字を区別します。フィールドが存在しない場合、フィールド名は無視されます。

links(optional): string

レスポンス内のincludeへのリンク関係名のカンマ区切りリスト。デフォルトでは、すべてのリンクが返されます。

次のリンクは、このリソースにより提供されます:

リンク関係	説明
`parent`	親リソースが読取り可能な場所を示します。このリンクは`up`リンクに相当し、親リソース(単数形のリソースを含むコレクション・リソースなど)へのリンクを提供します。
`self`	リソースの現在の戻り表現を示します。リソース自体を表すリンクに使用されます。たとえば、リソースがコレクションの一部として戻された場合、自己リンクは個々のリソースのURLパスを提供します。
`canonical`	リクエストされたリソースの優先表現を示します。リソースの標準的な形式を表すリンクに使用されます。たとえば、リソースがコレクションの一部として返される場合、正規リンクは個々のリソースの正規の形式のURLパスを提供します。
`edit`	リソースを編集できる場所について説明します。単一のリソースで使用され、既存のリソースを編集するためにパッチを実行できる場所を示します。
`edit-form`	リソース編集用のテンプレート・リクエスト本文を読むことができる場所を説明します。編集フォームには、リソースの編集に使用できるプロパティの詳細が表示されます。
`describedBy`	リソースに関するメタデータ情報を提供するスキーマ・リソースが記述されます。スキーマ・リソースがリソースを説明する場所を示すために、コレクション・リソース、単数形およびリレーション・リソースで使用されます。

return(optional): string

レスポンス・フィールドおよびリンクの制御に使用するリソース表現を指定します。表現が指定されない場合、fields、excludeFields、links、excludeLinksおよびexpand問合せパラメータの値に基づいて、クライアント定義の表現が戻されます。

次の表現は、return問合せパラメータでサポートされています:

表現	説明
`representation`	フル・リソース表示には、すべてのプロパティとリンクが含まれ、大部分の関係が拡張されます。
`default`	デフォルトのリソース表示には、ほとんどのプロパティとリンクが含まれます。
`basic`	基本的なリソース表現には、いくつかのプロパティといくつかのリンクが含まれます。
`minimal`	最小リソース表現。必須プロパティとリンクなしが含まれます。

トップに戻る

レスポンス

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

application/json
application/vnd.oracle.resource+json;type=singular

200レスポンス

ヘッダー

Cache-Control: string

キャッシュ・メカニズムのディレクティブ。
Content-Length: string

レスポンス本文のサイズ。
Content-Type: string

レスポンスのコンテンツ・タイプ。

ルート・スキーマ: schema

すべてに一致

ソースを表示

allOf SitesManagementSettings

サイト管理の設定。
リリース20.1.2で導入されました。

{
    "allOf":[
        {
            "$ref":"#/definitions/SitesManagementSettings"
        }
    ]
}

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

サイト管理の設定。

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

すべてに一致

ソースを表示

object SingularResource

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

{
    "description":"<p>Sites Management settings.</p><small>Introduced in release 20.1.2.</small>",
    "allOf":[
        {
            "$ref":"#/definitions/SingularResource"
        },
        {
            "properties":{
                "allowSiteCreation":{
                    "description":"<p>Allow your service users to create sites. When you enable the ability to create sites, you allow all users to create templates and sites. If you disable site creation, users can still see and work with templates and other folders in the hierarchy. Users can also still work with an existing site if the site is shared with them. They can view, edit, and manage the site, depending on their role. When you enable sites functionality, users have the ability to publish any content they have access to, including confidential information. You might want to limit your users to creating only secured sites, so that users have to sign in before they can see the site content. For even more security, you can limit site creation to administrators.</p><small>Introduced in release 20.1.2.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"boolean"
                },
                "governanceEnabled":{
                    "description":"<p>Enable governance for sites to simplify and accelerate site delivery for business users, who are not site administrators, while giving site administrators an easy way to control and track sites from a centralized location.</p><small>Introduced in release 20.1.2.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"boolean"
                },
                "siteSecurityPolicy":{
                    "description":"<p>Specify the minimum security allowed for online sites.</p><small>Introduced in release 20.1.2.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/SecurityPolicy"
                        }
                    ]
                },
                "siteAdminOnlyOperations":{
                    "description":"<p>Restrict site, template, theme and component creation to site administrators.</p><small>Introduced in release 20.1.2.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/SiteAdminOnlyOperations"
                        }
                    ]
                },
                "prerender":{
                    "description":"<p>Prerender service settings such as whether the prerender service is enabled.</p><small>Introduced in release 20.1.2.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/PrerenderSettings"
                        }
                    ]
                },
                "expiration":{
                    "description":"<p>Site expiration settings such as whether sites are automatically taken offline and deleted when the site expires.</p><small>Introduced in release 20.3.1.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/SiteExpirationSettings"
                        }
                    ]
                }
            }
        }
    ]
}

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

型: object

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

ソースを表示

links(optional): array links

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

{
    "description":"<p>All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the <em>self</em> link the resource itself.</p>",
    "properties":{
        "links":{
            "description":"<p>HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/Link"
                    }
                ]
            }
        }
    }
}

ネストされたスキーマ : SitesManagementSettings-allOf[1]

型: object

ソースを表示

allowSiteCreation(optional): boolean

サービス・ユーザーにサイトの作成を許可します。サイトを作成する機能を有効にすると、すべてのユーザーがテンプレートおよびサイトを作成できるようになります。サイトの作成を無効化しても、ユーザーは、階層内のテンプレートおよび他のフォルダを表示し操作できます。また、サイトを共有している場合、既存のサイトを操作できます。ロールに応じて、サイトを表示、編集および管理できます。サイト機能を有効にした場合、ユーザーは、機密情報を含め、自分がアクセス権を持つコンテンツを公開できます。ユーザーをセキュアなサイトのみの作成に制限できます。これにより、ユーザーはサイトのコンテンツを表示する前にサインインしなければならなくなります。さらにセキュリティを高めるために、サイトの作成を管理者に限定できます。
リリース20.1.2で導入されました。
expiration(optional): 有効期限

サイトの失効設定(サイトの失効時にサイトが自動的にオフラインにされ削除されるかどうかなど)。
リリース20.3.1で導入されました。
governanceEnabled(optional): boolean

サイトのガバナンスを有効にして、サイト管理者ではないビジネス・ユーザーのサイト配信を簡略化および高速化し、サイト管理者が一元化されたロケーションからサイトを簡単に制御および追跡できるようにします。
リリース20.1.2で導入されました。
prerender(optional): prerender

サービス設定(サービスが有効かどうかなど)。
リリース20.1.2で導入されました。
siteAdminOnlyOperations(optional): siteAdminOnlyOperations

サイト、テンプレート、テーマおよびコンポーネントの作成をサイト管理者に制限します。
リリース20.1.2で導入されました。
siteSecurityPolicy(optional): siteSecurityPolicy

オンライン・サイトで許可される最小セキュリティを指定します。
リリース20.1.2で導入されました。

{
    "properties":{
        "allowSiteCreation":{
            "description":"<p>Allow your service users to create sites. When you enable the ability to create sites, you allow all users to create templates and sites. If you disable site creation, users can still see and work with templates and other folders in the hierarchy. Users can also still work with an existing site if the site is shared with them. They can view, edit, and manage the site, depending on their role. When you enable sites functionality, users have the ability to publish any content they have access to, including confidential information. You might want to limit your users to creating only secured sites, so that users have to sign in before they can see the site content. For even more security, you can limit site creation to administrators.</p><small>Introduced in release 20.1.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "governanceEnabled":{
            "description":"<p>Enable governance for sites to simplify and accelerate site delivery for business users, who are not site administrators, while giving site administrators an easy way to control and track sites from a centralized location.</p><small>Introduced in release 20.1.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "siteSecurityPolicy":{
            "description":"<p>Specify the minimum security allowed for online sites.</p><small>Introduced in release 20.1.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/SecurityPolicy"
                }
            ]
        },
        "siteAdminOnlyOperations":{
            "description":"<p>Restrict site, template, theme and component creation to site administrators.</p><small>Introduced in release 20.1.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/SiteAdminOnlyOperations"
                }
            ]
        },
        "prerender":{
            "description":"<p>Prerender service settings such as whether the prerender service is enabled.</p><small>Introduced in release 20.1.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/PrerenderSettings"
                }
            ]
        },
        "expiration":{
            "description":"<p>Site expiration settings such as whether sites are automatically taken offline and deleted when the site expires.</p><small>Introduced in release 20.3.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/SiteExpirationSettings"
                }
            ]
        }
    }
}

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

型: array

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

ソースを表示

Array of: items

{
    "description":"<p>HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/Link"
            }
        ]
    }
}

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

すべてに一致

ソースを表示

object 「リンク」

REST HATEOASリンクおよび関連メタデータ。レスポンスがリンクを提供する場合(リソース自体へのselfリンクなど)、提供されるリンクには、このリンク構造で定義された1つ以上のプロパティが含まれます。

{
    "allOf":[
        {
            "$ref":"#/definitions/Link"
        }
    ]
}

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

型: 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とみなすことができます。

{
    "description":"<p>REST HATEOAS link and related metadata. If responses provide links (for example, a <code>self</code> link to the resource itself) the links provided will include one or more of the properties defined on this link structure.</p>",
    "properties":{
        "rel":{
            "description":"<p>Name of the link relation that, in addition to the type property, can be used to retrieve link details.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "href":{
            "description":"<p>The target resource URI. URI <em>RFC3986</em> or URI Template <em>RFC6570</em>. If the value is set to URI Template, then the <code>templated</code> property must be set to <code>true</code>.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "templated":{
            "description":"<p>Boolean flag that specifies the <code>href</code> property is a URI or URI Template. The property can be assumed to be <code>false</code> if the property is not present.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "mediaType":{
            "description":"<p>Media type, as defined by RFC 2046, describing the link target.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "method":{
            "description":"<p>HTTP method for requesting the target of the link.</p><p>Valid values are:\n<ul><li> <code>OPTIONS</code> - HTTP OPTIONS</li><li> <code>HEAD</code> - HTTP HEAD</li><li> <code>GET</code> - HTTP GET</li><li> <code>POST</code> - HTTP POST</li><li> <code>PUT</code> - HTTP PUT</li><li> <code>PATCH</code> - HTTP PATCH</li><li> <code>DELETE</code> - HTTP DELETE</li></p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "profile":{
            "description":"<p>Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"uri"
        }
    }
}

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

サイトの失効設定(サイトの失効時にサイトが自動的にオフラインにされ削除されるかどうかなど)。

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

すべてに一致

ソースを表示

object SiteExpirationSettings

サイト失効関連の設定(自動サイトの非アクティブ化および削除の有効化または無効化など)。サイトの有効期限は、サイト・ガバナンスが有効になっている場合にのみ有効です。
リリース20.3.1で導入されました。

{
    "description":"<p>Site expiration settings such as whether sites are automatically taken offline and deleted when the site expires.</p><small>Introduced in release 20.3.1.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/SiteExpirationSettings"
        }
    ]
}

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

サービス設定(サービスが有効かどうかなど)。

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

すべてに一致

ソースを表示

object PrerenderSettings

事前レンダリング・サービスの有効化または無効化、クローラおよびボット・ユーザー・エージェントの構成など、検索エンジンの最適化関連の設定。
リリース20.1.2で導入されました。

{
    "description":"<p>Prerender service settings such as whether the prerender service is enabled.</p><small>Introduced in release 20.1.2.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/PrerenderSettings"
        }
    ]
}

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

サイト、テンプレート、テーマおよびコンポーネントの作成をサイト管理者に制限します。

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

すべてに一致

ソースを表示

object SiteAdminOnlyOperations

サイト管理者に制限される操作を定義します。
リリース20.1.2で導入されました。

{
    "description":"<p>Restrict site, template, theme and component creation to site administrators.</p><small>Introduced in release 20.1.2.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/SiteAdminOnlyOperations"
        }
    ]
}

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

オンライン・サイトで許可される最小セキュリティを指定します。

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

すべてに一致

ソースを表示

object SecurityPolicy

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

{
    "description":"<p>Specify the minimum security allowed for online sites.</p><small>Introduced in release 20.1.2.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/SecurityPolicy"
        }
    ]
}

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

型: object

サイト失効関連の設定(自動サイトの非アクティブ化および削除の有効化または無効化など)。サイトの有効期限は、サイト・ガバナンスが有効になっている場合にのみ有効です。

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

ソースを表示

action(optional): string
サイトの期限が切れたときに実行するアクション。これは何もできない可能性があります。サイトがオンラインの場合、サイトはオンラインのままになります。非アクティブ化アクションは、サイトの期限が切れた後にサイトをオフラインにします。サイトの期限が切れてサイトも削除されると、削除アクションはサイトをオフラインにします。サイトは、サイトが削除されるまでの失効後の期間を判断するために、翌日を使用して削除されます。
有効な値は次のとおりです。
- nothing - サイトはオンラインのままなので削除されません
- deactivate - サイトは、サイトの期限が切れるとオフラインになります
- delete - サイトは、有効期限が切れた後に構成可能な日数後にサイトの期限が切れるとオフラインになります
リリース20.3.1で導入されました。
deleteAfter(optional): integer(int32)

最小値: 3

最大値: 90

サイトを削除する前に、サイトが失効してから待機する日数。この設定は、選択したアクションが期限切れサイトを削除する場合にのみ使用されます。サイトの削除が無効になっている場合、この設定は引き続き設定できます。設定値は無視されます。
リリース20.3.1で導入されました。

{
    "description":"<p>Site expiration related settings, such as enabling or disabling automatic site deactivation and deletion. Site expiration only takes affect if site governance is enabled.</p><small>Introduced in release 20.3.1.</small>",
    "properties":{
        "action":{
            "description":"<p>What action to take when the site expires. This can be do nothing. If the site is online the site will remain online. The deactivate action takes the site offline after the site expires. The delete action takes the site offline after the site expires and also deletes the site. The site is deleted using the days after to determine how long after expiration before the site is deleted.</p><p>Valid values are:\n<ul><li> <code>nothing</code> - Site is left online and is not deleted</li><li> <code>deactivate</code> - Site is taken offline when the site expires</li><li> <code>delete</code> - Site is taken offline when the site expires and deleted after a configurable number of days after expiration</li></p><small>Introduced in release 20.3.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "deleteAfter":{
            "description":"<p>Number of days to wait after a site expires before deleting the site. This setting is only used if the action selected is to delete expired sites. This setting can still be set if site deletion is disabled; the setting value will just be ignored. </p><small>Introduced in release 20.3.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"integer",
            "format":"int32",
            "maximum":90,
            "minimum":3
        }
    }
}

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

型: object

事前レンダリング・サービスの有効化または無効化、クローラおよびボット・ユーザー・エージェントの構成など、検索エンジンの最適化関連の設定。

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

ソースを表示

enabled(optional): boolean

Prerenderサービスを有効または無効にします。
リリース20.1.2で導入されました。
userAgents(optional): string

検出されると、クライアント(クローラおよびボット)がレンダリング前に生成されたキャッシュ済サイト・コンテンツにリダイレクトされるユーザー・エージェント製品名のカンマ区切りリスト。 Oracle Content Managementには、このカスタム・ユーザー・エージェント製品名と組み合せたクローラおよびボットのリストが組み込まれています。
リリース20.1.2で導入されました。

{
    "description":"<p>Search engine optimization related settings, such as enabling or disabling the pre-render service and configuring crawler and bot user-agents.</p><small>Introduced in release 20.1.2.</small>",
    "properties":{
        "enabled":{
            "description":"<p>Enable or disable the Prerender Service.</p><small>Introduced in release 20.1.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "userAgents":{
            "description":"<p>Comma-separated list of user-agent product names that, if detected, will cause the client (crawlers and bots) to be redirected to the pre-render generated cached site content. Oracle Content Management has a built in list of crawlers and bots with is combined with this custom user-agent product names.</p><small>Introduced in release 20.1.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        }
    }
}

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

型: object

サイト管理者に制限される操作を定義します。

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

ソースを表示

componentCreation(optional): boolean

Trueの場合、サイト管理者のみがコンポーネントを作成できます。
リリース20.1.2で導入されました。
siteCreation(optional): boolean

Trueの場合、サイト管理者のみがサイトを作成できます。ガバナンスが有効な場合は無視されます。
リリース20.1.2で導入されました。
templateCreation(optional): boolean

Trueの場合、サイト管理者のみがテンプレートを作成できます。
リリース20.1.2で導入されました。
themeCreation(optional): boolean

Trueの場合、サイト管理者のみがテーマを作成できます。
リリース20.1.2で導入されました。

{
    "description":"<p>Defines the operations restricted to Site Administrators.</p><small>Introduced in release 20.1.2.</small>",
    "properties":{
        "siteCreation":{
            "description":"<p>If true, only site administrators can create sites. Ignored if governance is enabled.</p><small>Introduced in release 20.1.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "templateCreation":{
            "description":"<p>If true, only site administrators can create templates.</p><small>Introduced in release 20.1.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "themeCreation":{
            "description":"<p>If true, only site administrators can create themes.</p><small>Introduced in release 20.1.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "componentCreation":{
            "description":"<p>If true, only site administrators can create components.</p><small>Introduced in release 20.1.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        }
    }
}

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

型: object

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

ソースを表示

appliesTo(optional): string
サイトにアクセス可能なユーザーのタイプを定義します。すべてのユーザーを含めることも、指定ユーザーのみに制限することもできます。
有効な値は次のとおりです。
- named - 指定されたレベル内の指定ユーザーのみがアクセスできます
- all - 指定されたレベル内のすべてのユーザーがアクセスできます
level(optional): string
サイトに設定できる最大オープン・セキュリティ・レベル。
有効な値は次のとおりです。
- service - サービス・ユーザーのみ
- cloud - ドメインにサインインできるクラウド・ユーザーのみ
- everyone - サインインせずに誰でも

{
    "description":"<p>The security policy specifies the minimum level of security level a site will be allowed to have. The site will be created with this minimum level, and the site manager/owner can then set a more restrictive security level on the site if they wish. The manager/owner cannot select a security level that is less secure than the values specified on the sites security policy.</p>",
    "properties":{
        "level":{
            "description":"<p>Maximum open security level that can be set on a site.</p><p>Valid values are:\n<ul><li> <code>service</code> - Only service users</li><li> <code>cloud</code> - Only cloud users who can sign in to your domain</li><li> <code>everyone</code> - Anyone without signing in</li></p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "appliesTo":{
            "description":"<p>Define which types of users may access a site. Can include all users or be restricted to named users only.</p><p>Valid values are:\n<ul><li> <code>named</code> - Only named users within a specified level can access</li><li> <code>all</code> - All users within a specified level can access</li></p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        }
    }
}

レスポンスの例 ()

{
    "allowSiteCreation":false,
    "governanceEnabled":false,
    "siteSecurityPolicy":{
        "level":"service",
        "appliesTo":"named"
    },
    "siteAdminOnlyOperations":{
        "siteCreation":false,
        "templateCreation":false,
        "themeCreation":false,
        "componentCreation":false
    },
    "prerender":{
        "enabled":false,
        "userAgents":"AdsBot-Google,AdsBot-Google-Mobile-Apps,AppEngine-Google"
    },
    "expiration":{
        "action":"nothing",
        "deleteAfter":30
    }
}

400レスポンス

不正なリクエスト

401レスポンス

未認可

406レスポンス

受入れられない

416 レスポンス

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

429 レスポンス

リクエストが多すぎます

500レスポンス

内部サーバー・エラー

501レスポンス

実装されていない

502 レスポンス

ゲートウェイが不良

503レスポンス

サービス使用不可

504レスポンス

ゲートウェイがタイムアウト

先頭に戻る