Jump to

• Request
• Response

Get the Site Management Settings

get

/sites/management/api/v1/settings

SINGULAR

Provides service wide sites managements related settings, such as controlling who can create sites, templates, themes and components, enabling site governance and whether the site prerender service is enabled.

Introduced in release 20.1.2.

Successful Response Examples

This operation responds with the following success (2xx) responses. For a full list of response HTTP status codes and example bodies, consult the Response section of this operation.

200OK

Request

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

Response Body

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

Request

Query Parameters

• excludeFields(optional): string

  Comma-delimited string of field names that should not be included in the response.

• excludeLinks(optional): string

  Comma-separated list of link relation names to exclude from the response.

• fields(optional): string

  Comma-delimited string of field names to include in the response. Nested fields can be identified using a dot to separate the field names. Field names are case-sensitive. Field names are ignored if the field does not exist.

• links(optional): string

  Comma-separated list of link relation names to include in the response. By default, all links are returned.

  The following links are provided by this resource:

  Link Relationship	Description
  parent	Describes where the parent resource can be read. Equivalent to an up link, this link provides the link to the parent resource, such as the collection resource that contains a singular resource.
  self	Describes the current returned representation of the resource. Used for links that represent the resource itself. For example, if a resource is returned as part of a collection, the self link will provide the URL path for the individual resource.
  canonical	Describes the preferred representation of the requested resource. Used for links that represent the canonical form of the resource. For example, if a resource is returned as part of a collection, the canonical link will provide the URL path for the canonical form of the individual resource.
  edit	Describes where the resource can be edited. Used on singular resources to indicate where a patch can be performed to edit an existing resource.
  edit-form	Describes where a template request body for editing a resource can be read. The edit form provides details of what properties can be used to edit a resource.
  describedBy	Describes the schema resource providing metadata information about the resource. Used on collection, singular and relation resources to indicate where the schema resource is that describes the resource.

• return(optional): string

  Specify the resource representation that should be used to control the response fields and links. If no representation is specified, the client-defined representation is returned, based on the values of the fields, excludeFields, links, excludeLinks and expand query parameters.

  The following representations are supported with the return query parameter:

  Representation	Description
  representation	Full resource representation includes all properties and links and expands most relationships.
  default	Default resource representation includes most properties and links.
  basic	Basic resource representation includes some properties and some links.
  minimal	Minimal resource representation, includes essential properties and no links.

Back to Top

Response

Supported Media Types

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

200 Response

OK

Headers

• Cache-Control: string

  Directives for caching mechanisms.

• Content-Length: string

  Size of the response body.

• Content-Type: string

  Content type of the response.

Body ()

Root Schema : schema

Match All

Show Source

• allOf SitesManagementSettings

  Sites Management settings.

  Introduced in release 20.1.2.

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

Nested Schema : SitesManagementSettings

Sites Management settings.

Introduced in release 20.1.2.

Match All

Show Source

• object SingularResource

  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 self link the resource itself.

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

Nested Schema : SingularResource

Type: object

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 self link the resource itself.

Show Source

• links(optional): array links

  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.

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

Nested Schema : SitesManagementSettings-allOf[1]

Type: object

Show Source

• allowSiteCreation(optional): boolean

  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.

  Introduced in release 20.1.2.
• expiration(optional): expiration

  Site expiration settings such as whether sites are automatically taken offline and deleted when the site expires.

  Introduced in release 20.3.1.
• governanceEnabled(optional): boolean

  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.

  Introduced in release 20.1.2.
• prerender(optional): prerender

  Prerender service settings such as whether the prerender service is enabled.

  Introduced in release 20.1.2.
• siteAdminOnlyOperations(optional): siteAdminOnlyOperations

  Restrict site, template, theme and component creation to site administrators.

  Introduced in release 20.1.2.
• siteSecurityPolicy(optional): siteSecurityPolicy

  Specify the minimum security allowed for online sites.

  Introduced in release 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"
                }
            ]
        }
    }
}

Nested Schema : links

Type: array

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.

Show Source

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

Nested Schema : items

Match All

Show Source

• object Link

  REST HATEOAS link and related metadata. If responses provide links (for example, a self link to the resource itself) the links provided will include one or more of the properties defined on this link structure.

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

Nested Schema : Link

Type: object

REST HATEOAS link and related metadata. If responses provide links (for example, a self link to the resource itself) the links provided will include one or more of the properties defined on this link structure.

Show Source

• href(optional): string

  The target resource URI. URI RFC3986 or URI Template RFC6570. If the value is set to URI Template, then the templated property must be set to true.

• mediaType(optional): string

  Media type, as defined by RFC 2046, describing the link target.

• method(optional): string

  HTTP method for requesting the target of the link.

  Valid values are:

  • 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)

  Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource.

• rel(optional): string

  Name of the link relation that, in addition to the type property, can be used to retrieve link details.

• templated(optional): boolean

  Boolean flag that specifies the href property is a URI or URI Template. The property can be assumed to be false if the property is not present.

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

Nested Schema : expiration

Site expiration settings such as whether sites are automatically taken offline and deleted when the site expires.

Introduced in release 20.3.1.

Match All

Show Source

• object SiteExpirationSettings

  Site expiration related settings, such as enabling or disabling automatic site deactivation and deletion. Site expiration only takes affect if site governance is enabled.

  Introduced in release 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"
        }
    ]
}

Nested Schema : prerender

Prerender service settings such as whether the prerender service is enabled.

Introduced in release 20.1.2.

Match All

Show Source

• object PrerenderSettings

  Search engine optimization related settings, such as enabling or disabling the pre-render service and configuring crawler and bot user-agents.

  Introduced in release 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"
        }
    ]
}

Nested Schema : siteAdminOnlyOperations

Restrict site, template, theme and component creation to site administrators.

Introduced in release 20.1.2.

Match All

Show Source

• object SiteAdminOnlyOperations

  Defines the operations restricted to Site Administrators.

  Introduced in release 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"
        }
    ]
}

Nested Schema : siteSecurityPolicy

Specify the minimum security allowed for online sites.

Introduced in release 20.1.2.

Match All

Show Source

• object SecurityPolicy

  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.

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

Nested Schema : SiteExpirationSettings

Type: object

Site expiration related settings, such as enabling or disabling automatic site deactivation and deletion. Site expiration only takes affect if site governance is enabled.

Introduced in release 20.3.1.

Show Source

• action(optional): string

  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.

  Valid values are:

  • nothing - Site is left online and is not deleted
  • deactivate - Site is taken offline when the site expires
  • delete - Site is taken offline when the site expires and deleted after a configurable number of days after expiration

  Introduced in release 20.3.1.
• deleteAfter(optional): integer(int32)
  Minimum Value: 3

  Maximum Value: 90

  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.

  Introduced in release 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
        }
    }
}

Nested Schema : PrerenderSettings

Type: object

Search engine optimization related settings, such as enabling or disabling the pre-render service and configuring crawler and bot user-agents.

Introduced in release 20.1.2.

Show Source

• enabled(optional): boolean

  Enable or disable the Prerender Service.

  Introduced in release 20.1.2.
• userAgents(optional): string

  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.

  Introduced in release 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"
        }
    }
}

Nested Schema : SiteAdminOnlyOperations

Type: object

Defines the operations restricted to Site Administrators.

Introduced in release 20.1.2.

Show Source

• componentCreation(optional): boolean

  If true, only site administrators can create components.

  Introduced in release 20.1.2.
• siteCreation(optional): boolean

  If true, only site administrators can create sites. Ignored if governance is enabled.

  Introduced in release 20.1.2.
• templateCreation(optional): boolean

  If true, only site administrators can create templates.

  Introduced in release 20.1.2.
• themeCreation(optional): boolean

  If true, only site administrators can create themes.

  Introduced in release 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"
        }
    }
}

Nested Schema : SecurityPolicy

Type: object

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.

Show Source

• appliesTo(optional): string

  Define which types of users may access a site. Can include all users or be restricted to named users only.

  Valid values are:

  • named - Only named users within a specified level can access
  • all - All users within a specified level can access

• level(optional): string

  Maximum open security level that can be set on a site.

  Valid values are:

  • service - Only service users
  • cloud - Only cloud users who can sign in to your domain
  • everyone - Anyone without signing in

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

Example Response ()

{
    "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 Response

Bad Request

401 Response

Unauthorized

406 Response

Not Acceptable

416 Response

Range Not Satisfiable

429 Response

Too Many Requests

500 Response

Internal Server Error

501 Response

Not Implemented

502 Response

Bad Gateway

503 Response

Service Unavailable

504 Response

Gateway Timeout

Back to Top