1. REST API for Sites Management
  2. Tasks
  3. Policies

Batch Read Policies

get

/sites/management/api/v1/policies

COLLECTION

Read one or more policy resources in a single request. If multiple policies need to be read in a single call, batch reading can be used rather than reading individual policies.

Listing of policies is not supported; a batch query parameter must be provided.

Authorization

Polices can be read by site administrators. Policies with an access type of everyone can be read by any authenticated user. Policies with an access type of restricted can be read by an authenticated user or client application that is a member of the policy access list.

Get the Policy for Creating a Site

The policy associated with a template controls whether sites can be created from the template, who can create sites, who can approve the request and characteristics of the site, such as whether a site prefix is allowed.

For more information, see Get the Site Creation Policy for a Template.

Get the Policy for Copying a Site

When a site is created from a template the policy that was associated with the site template is used to create a policy for copying the site. The policy associated with the copy operation can then be read to determine what restrictions are placed on copying the site.

For more information, see Get the Copy Policy for a Site.

Get the Policy for Extending the Expiration Date of a Site

When a site is created from a template the policy that was associated with the site template is used to create a policy for extending the site expiration date. The policy associated with the extend operation can then be read to determine what restrictions are placed on extending the site expiration date.

For more information, see Get the Expiration Policy for a Site.

Batching

This operation supports batching of GET requests. Two or more resource instances up to a maximum of 1000 can be returned in a single batch response by specifying a comma-separated list of resource identifiers using the id query parameter. The response will contain details of each GET response, providing the response status code, headers and response body.

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 - Batch Read Two Policies

Read the details of two policies by providing two policy identifiers in a comma-separated list. Links are not included in the response.

Request

GET https://api.example.com/sites/management/api/v1/policies?id=721af08b-32db-4eee-b6af-0c38d3ba4681,bdab2bbf-ebd9-44f4-afe9-e4326bb6211f&links=none

Response Body

{
  "batch": [
      {
        "status": {
          "code": 200,
          "reason": "OK"
        },
        "headers": [
            {
              "name": "Content-Type",
              "value": "application/json"
            }
        ],
        "body": {
          "id": "721af08b-32db-4eee-b6af-0c38d3ba4681",
          "status": "inactive",
          "approvalType": "automatic",
          "accessType": "everyone",
          "security": {
            "level": "service",
            "appliesTo": "named"
          },
          "localizationPolicyAllowed": false,
          "sitePrefixAllowed": false,
          "expiration": {
            "amount": 1,
            "unit": "months"
          },
          "revision": 0
        }
      },
      {
        "status": {
          "code": 404,
          "reason": "Not Found"
        },
        "headers": [
            {
              "name": "Content-Type",
              "value": "application/vnd.oracle.resource+json;type=error"
            }
        ],
        "body": {
          "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
          "title": "Policy Not Found",
          "status": 404,
          "detail": "Policy 'bdab2bbf-ebd9-44f4-afe9-e4326bb6211f' does not exist, has been deleted or the authenticated user does not have access to the policy.",
          "o:errorCode": "OCE-SITEMGMT-009022",
          "o:errorDetails": [
          ]
        }
      }
  ]
}

Request

Query Parameters

  • Comma-delimited string of field names that you do not want 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. To reference the fields of the collection the field name can be prepended with the @ character (for example, @hasMore).

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

  • Comma-delimited string of field names that you want to expand. Use the value all to expand all relationships.

    The following field names can be specified in the expand query parameter:

    Field NameDescription
    approversList of users and groups who have the ability to approve any request associated with the policy.
    accessList of users and groups who have the ability to perform the operation associated with the policy.
    repositoryWhen a policy is created, or edited, the policy can be associated with an asset repository.

  • Specify how errors in expansion are handled. If not specified, then the default is to include error details in the relationship field.

    Valid values are:

    • ignore - Ignore the error and do not expand the relationship. Relationship links are not included in the response
    • include - Include the error details instead of the expanded relationship. Relationship links are returned
    • fail - Fail the request with an expansion failure error response

  • Comma-delimited string of field names that you want in the response. Nested properties 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. To reference the fields of the collection the field name can be prepended with the @ character (for example, @hasMore).

  • List of resource identifiers to use for a batched request. The syntax uses a comma-delimited sequence of resource identifiers.

  • 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 RelationshipDescription
    parentDescribes 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.
    selfDescribes 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.
    canonicalDescribes 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.
    childDescribes where a related or child resource can be read. Child links are returned in expandable properties and provide the location where unexpanded relationship details can be read.
    prevDescribes the previous page of results, if a previous page exists. Used with collection resources to provide a previous-page link based on the response to a paged request that specified the offset and limit query parameters.
    nextDescribes the next page of results, if a next page exists. Used with collection resources to provide a next-page link based on the response to a paged request that specified the offset and limit query parameters.
    describedByDescribes 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.

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

    RepresentationDescription
    representationFull resource representation includes all properties and links and expands most relationships.
    defaultDefault resource representation includes most properties and links.
    basicBasic resource representation includes some properties and some links.
    minimalMinimal resource representation, includes essential properties and no links.
Back to Top

Response

Supported Media Types

200 Response

OK
Headers
Body ()
Root Schema : schema
Type: object
Show Source
Match All
Show Source
  • CollectionResource

    All collections returned by REST APIs extend the standard collection definition. The definition provides information about the total number of items, the offset and limit details for the items returned, the number of items and an indicator to whether there are more items available.

Nested Schema : items
Type: array

Collection of Policy elements.

Show Source
Nested Schema : CollectionResource

All collections returned by REST APIs extend the standard collection definition. The definition provides information about the total number of items, the offset and limit details for the items returned, the number of items and an indicator to whether there are more items available.

Match All
Show Source
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
Nested Schema : CollectionResource-allOf[1]
Type: object
Show Source

  • Total number of resources in the response.

  • Collection has more elements that match the request. Indicates whether there are more items to be returned when a paged request is made and the page was not big enough to return all elements.

  • Actual response size limit used. If the request specifies too large a limit, or does not specify a limit then the response will specify the limit used.

  • Actual response offset used. If the request specifies no offset then the actual offset is provided in the response.

  • Total number of resources that match the request. If provided, this is the total number of available items. If not specified the total is not known, or is not viable to return. Paging limits or offsets are ignored when calculating this value. Only returned if the totalResults parameter is supported and is set to true by the client.

Nested Schema : items
Match All
Show Source
  • Policy

    A policy controls how a request to perform a site-related operation is approved and whether there are any particular restrictions or defaults to apply when that operation is performed.

    A policy is associated with a resource, for example a site creation policy can be associated with a site template. A site creation policy, for example, could specify that site administrator approval is required to create a site from a particular site template and that site template has a security level of domain users only.

    A policy can be marked as inactive which prevents the operation from being performed or requested.

Nested Schema : Policy

A policy controls how a request to perform a site-related operation is approved and whether there are any particular restrictions or defaults to apply when that operation is performed.

A policy is associated with a resource, for example a site creation policy can be associated with a site template. A site creation policy, for example, could specify that site administrator approval is required to create a site from a particular site template and that site template has a security level of domain users only.

A policy can be marked as inactive which prevents the operation from being performed or requested.

Match All
Show Source
  • 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.

  • Policy-allOf[1]
Nested Schema : Policy-allOf[1]
Type: object
Show Source
  • access

    List of users and groups who have the ability to perform the operation associated with the policy. For example, the list of users and groups who can create a site from a template. If the access list is empty all users can perform the policy operation. The access list is only used if the accessType of the policy is set to restricted.

    Introduced in release 19.3.1.

  • Determines whether the policy is applicable to everyone, or to just the users that are part of the access list.

    Valid values are:

    • everyone - Policy, when active, is applicable to everyone
    • restricted - Policy, when active, is applicable to users that are part of the access list

    Introduced in release 19.3.1.

  • When a request is made that is associated with this policy, the request will require the type of approval defined by the policy. If the type of approval is automatic then the request will not require manual approval.

    Valid values are:

    • automatic - A request will automatically be approved without any human approval process involved
    • admin - Any user with the site administrator role can approve the associated request
    • named - Site creation will require approval from one user that is a member of the approvers list associated with the policy

  • approvers

    List of users and groups who have the ability to approve any request associated with the policy. For example, the list of users and groups who can approve creating a site from a template. The approval list is only used if the approval type is set to named approvers.

    Introduced in release 19.3.3.
  • expiration

    When a site is created an expiration date can be set on the site if the policy associated with the site template has a site expiration period set. When a site has expired the site cannot be activated unless the expiration period is extended.

    Introduced in release 19.4.1.

  • Globally unique identifier for a policy.

    No assumptions should be made about the content of the field; the field should be treated as an opaque value.

  • If a localization policy is not allowed, then the requester will not be permitted to specify a localization policy at the time of requesting a site. The localization policy associated with the template will be used. If a localization policy is allowed, then the requester must specify one at the time of requesting a site. This property can be set only when the template associated with the policy is an enterprise templates.

    Introduced in release 19.2.3.
  • repository

    When a policy is created, or edited, the policy can be associated with an asset repository. When a new site is requested, the site will be associated with the policy-defined asset repository. The user cannot specify a repository when creating a new a site if the repository is set on the policy. If there is no asset repository associated with the policy, then an asset repository can be specified when the user creates a new site. An asset repository can be only associated with a policy if the policy is associated with an enterprise template. Standard sites do not get associated with an asset repository.

    Introduced in release 19.2.3.

  • Every time a policy is edited, the revision number is incremented. Revision numbers start at zero. The revision number can be used to see if a policy has changed since it was last requested as the revision is also used as the strong ETag value for this resource.

  • security

    Security policy for site creation policies. The security policy specifies the minimum level of security a site can have.

  • If true, a request for a new site can include an explicit site prefix. If false, then a site prefix must not be provided and will be generated automatically. This property can be set only when the template associated with the policy is an enterprise templates.

    Introduced in release 19.2.3.

  • The policy status specifies whether the policy can be used to perform the operation associated with the policy. If the policy status is inactive then the operation cannot be performed. If the policy status is active then the operation can be performed. For example, for a policy associated with a site template, a status of active means that users can create sites from that site template.

    Valid values are:

    • inactive - Policy that is marked as inactive means the associated operation cannot be requested
    • active - Policy that is marked as active means the associated operation can be requested

Nested Schema : access
Type: object

List of users and groups who have the ability to perform the operation associated with the policy. For example, the list of users and groups who can create a site from a template. If the access list is empty all users can perform the policy operation. The access list is only used if the accessType of the policy is set to restricted.

Introduced in release 19.3.1.
Show Source
Match All
Show Source
  • CollectionResource

    All collections returned by REST APIs extend the standard collection definition. The definition provides information about the total number of items, the offset and limit details for the items returned, the number of items and an indicator to whether there are more items available.

Nested Schema : approvers
Type: object

List of users and groups who have the ability to approve any request associated with the policy. For example, the list of users and groups who can approve creating a site from a template. The approval list is only used if the approval type is set to named approvers.

Introduced in release 19.3.3.
Show Source
  • items

    Collection of Policy Approvers Member elements.

    Introduced in release 19.3.3.
Match All
Show Source
  • CollectionResource

    All collections returned by REST APIs extend the standard collection definition. The definition provides information about the total number of items, the offset and limit details for the items returned, the number of items and an indicator to whether there are more items available.

Nested Schema : expiration

When a site is created an expiration date can be set on the site if the policy associated with the site template has a site expiration period set. When a site has expired the site cannot be activated unless the expiration period is extended.

Introduced in release 19.4.1.
Match All
Show Source
  • SiteExpirationPeriod

    Site expiration is expressed as a unit of time and and an amount. For example, expire a site two months after the site is created.

    Introduced in release 19.4.1.
Nested Schema : repository

When a policy is created, or edited, the policy can be associated with an asset repository. When a new site is requested, the site will be associated with the policy-defined asset repository. The user cannot specify a repository when creating a new a site if the repository is set on the policy. If there is no asset repository associated with the policy, then an asset repository can be specified when the user creates a new site. An asset repository can be only associated with a policy if the policy is associated with an enterprise template. Standard sites do not get associated with an asset repository.

Introduced in release 19.2.3.
Match All
Show Source
  • Repository

    Repositories are a storage location for files, both text and images. Repository administrators can create a repository with channel policies and localization policies designated for the repository. Multiple repositories can be created to handle different marketing needs.

    A repository can be used to manage all the assets you need in one place. For example, perhaps your company sells computer equipment. One repository could be set up to handle the files related to desktop computers. Another repository could be used for tablets. Each repository might contain photos, graphics, and content about the different kinds of computers. The assets in each repository are controlled by the policies you allocate to the repository.

Nested Schema : security

Security policy for site creation policies. The security policy specifies the minimum level of security a site can have.

Match All
Show Source
  • 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.

Nested Schema : items
Type: array

Collection of Policy Access Member elements.

Introduced in release 19.3.1.
Show Source
Nested Schema : items
Type: object
Show Source

  • Display name for the user, client application or group.

    Introduced in release 19.3.1.
  • group

    Group details of the member. Only available if the member has a type of group.

    Introduced in release 19.3.1.

  • If the member is a group, then the type of group is specified. If the member is a user this field is not present.

    Valid values are:

    • oce - Content management group
    • idp - identity provider group

    Introduced in release 20.1.1.

  • Identifier for the user, client application or group member.

    No assumptions should be made about the content of the field; the field should be treated as an opaque value.

    Introduced in release 19.3.1.

  • Will be set to true if the associated user or client application has only the external user role.

    Introduced in release 21.10.2.

  • Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.

    Introduced in release 19.3.1.

  • Indicates the member is a user, client application or group.

    Valid values are:

    • user - Member is a user or a client application. No distinction is made between a member that is a user or a
    member that is a client application.
    • group - Member is a group

    Introduced in release 19.3.1.
  • user

    User or client application details of the member. Only available if the member has a type of user. A member can be a user, client application or group. The details of both users and client applications can be read.

    Introduced in release 19.3.1.
Nested Schema : group

Group details of the member. Only available if the member has a type of group.

Introduced in release 19.3.1.
Match All
Show Source
  • Group

    A group is a collection of users and groups. A group has a human readable group name.

    Introduced in release 19.3.1.
Nested Schema : user

User or client application details of the member. Only available if the member has a type of user. A member can be a user, client application or group. The details of both users and client applications can be read.

Introduced in release 19.3.1.
Match All
Show Source
  • Identity
    Discriminator: type

    Identity representing a user or client application. The identity contains the common information such as the identity identifier, unique name and display name.

    Introduced in release 20.3.1.
Nested Schema : Group

A group is a collection of users and groups. A group has a human readable group name.

Introduced in release 19.3.1.
Match All
Show Source
  • 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.

  • Group-allOf[1]
Nested Schema : Group-allOf[1]
Type: object
Show Source

  • Human-readable name for the group.

    Introduced in release 19.3.1.

  • Group name that is unique within the service instance.

    Introduced in release 19.3.1.

  • Unique identifer for the group.

    No assumptions should be made about the content of the field; the field should be treated as an opaque value.

    Introduced in release 19.3.1.
  • roles

    Roles.

    Valid values are:

    • CECServiceAdministrator - Service Administrator
    • Assign user enumerates
    • Change user passwords and challenge questions
    • Configure, monitor, and manage service instances
    • CECSitesAdministrator - Sites Administrator
    • Create sites, templates, themes or components
    • CECRepositoryAdministrator - Repository Administrator
    • CECDeveloperUser - Developer User
    • CECContentAdministrator - Content Administrator
    • Create new content types and publish items
    • CECStandardUser - Standard User
    • Manage content (view, upload, and edit documents)
    • Share content and sites with others
    • Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)
    • Follow people
    • Create, edit, and publish sites
    • Manage and publish site themes
    • Create, register, export, and import custom site components
    • Create, edit, export, and import site templates
    • View and interact with content items in sites
    • Manage and view custom properties and edit values
    • CECEnterpriseUser - Enterprise User
    • Manage content (view, upload, and edit documents)
    • Share content and sites with others
    • Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)
    • Follow people
    • Digital Assets
    • Content Items (editorial content management)
    • Create, manage, view, and interact with content items
    • Collections
    • Create, edit, and publish sites
    • Manage and publish site themes
    • Create, register, export, and import custom site components
    • Create, edit, export, and import site templates
    • Manage and view custom properties and edit values
    • CECExternalUser - External User
    Reserved for future use.
    • CECIntegrationUser - Integration User
    Used to impersonate another user while performing operations through the Social REST endpoints of the REST API for Collaboration.
    • CECSitesVisitor - Sites Visitor
    Access sites restricted to visitors.

    Introduced in release 21.10.2.

  • Type of the group.

    Valid values are:

    • oce - Content management group
    • idp - identity provider group

    Introduced in release 19.3.1.
Nested Schema : roles
Type: array

Roles.

Valid values are:

  • CECServiceAdministrator - Service Administrator
  • Assign user enumerates
  • Change user passwords and challenge questions
  • Configure, monitor, and manage service instances
  • CECSitesAdministrator - Sites Administrator
  • Create sites, templates, themes or components
  • CECRepositoryAdministrator - Repository Administrator
  • CECDeveloperUser - Developer User
  • CECContentAdministrator - Content Administrator
  • Create new content types and publish items
  • CECStandardUser - Standard User
  • Manage content (view, upload, and edit documents)
  • Share content and sites with others
  • Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)
  • Follow people
  • Create, edit, and publish sites
  • Manage and publish site themes
  • Create, register, export, and import custom site components
  • Create, edit, export, and import site templates
  • View and interact with content items in sites
  • Manage and view custom properties and edit values
  • CECEnterpriseUser - Enterprise User
  • Manage content (view, upload, and edit documents)
  • Share content and sites with others
  • Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)
  • Follow people
  • Digital Assets
  • Content Items (editorial content management)
  • Create, manage, view, and interact with content items
  • Collections
  • Create, edit, and publish sites
  • Manage and publish site themes
  • Create, register, export, and import custom site components
  • Create, edit, export, and import site templates
  • Manage and view custom properties and edit values
  • CECExternalUser - External User
Reserved for future use.
  • CECIntegrationUser - Integration User
Used to impersonate another user while performing operations through the Social REST endpoints of the REST API for Collaboration.
  • CECSitesVisitor - Sites Visitor
Access sites restricted to visitors.

Introduced in release 21.10.2.
Show Source
Nested Schema : Identity
Discriminator: type

Identity representing a user or client application. The identity contains the common information such as the identity identifier, unique name and display name.

Introduced in release 20.3.1.
Match All
Show Source
  • 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.

  • Identity-allOf[1]
Nested Schema : Identity-allOf[1]
Type: object
Show Source

  • Human-readable display name.

    Introduced in release 20.3.1.

  • An identifier value allocated by CEC for the user or client application. The identifier is unique within the scope of the service.

    No assumptions should be made about the content of the field; the field should be treated as an opaque value.

    Introduced in release 20.3.1.

  • Unique name, such as the user name or client application name.

    Introduced in release 20.3.1.
  • roles

    Roles.

    Valid values are:

    • CECServiceAdministrator - Service Administrator
    • Assign user enumerates
    • Change user passwords and challenge questions
    • Configure, monitor, and manage service instances
    • CECSitesAdministrator - Sites Administrator
    • Create sites, templates, themes or components
    • CECRepositoryAdministrator - Repository Administrator
    • CECDeveloperUser - Developer User
    • CECContentAdministrator - Content Administrator
    • Create new content types and publish items
    • CECStandardUser - Standard User
    • Manage content (view, upload, and edit documents)
    • Share content and sites with others
    • Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)
    • Follow people
    • Create, edit, and publish sites
    • Manage and publish site themes
    • Create, register, export, and import custom site components
    • Create, edit, export, and import site templates
    • View and interact with content items in sites
    • Manage and view custom properties and edit values
    • CECEnterpriseUser - Enterprise User
    • Manage content (view, upload, and edit documents)
    • Share content and sites with others
    • Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)
    • Follow people
    • Digital Assets
    • Content Items (editorial content management)
    • Create, manage, view, and interact with content items
    • Collections
    • Create, edit, and publish sites
    • Manage and publish site themes
    • Create, register, export, and import custom site components
    • Create, edit, export, and import site templates
    • Manage and view custom properties and edit values
    • CECExternalUser - External User
    Reserved for future use.
    • CECIntegrationUser - Integration User
    Used to impersonate another user while performing operations through the Social REST endpoints of the REST API for Collaboration.
    • CECSitesVisitor - Sites Visitor
    Access sites restricted to visitors.

    Introduced in release 21.10.2.

  • Type of Identity. Valid values are: user, service, application, unknown.

    Introduced in release 20.3.1.
Nested Schema : roles
Type: array

Roles.

Valid values are:

  • CECServiceAdministrator - Service Administrator
  • Assign user enumerates
  • Change user passwords and challenge questions
  • Configure, monitor, and manage service instances
  • CECSitesAdministrator - Sites Administrator
  • Create sites, templates, themes or components
  • CECRepositoryAdministrator - Repository Administrator
  • CECDeveloperUser - Developer User
  • CECContentAdministrator - Content Administrator
  • Create new content types and publish items
  • CECStandardUser - Standard User
  • Manage content (view, upload, and edit documents)
  • Share content and sites with others
  • Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)
  • Follow people
  • Create, edit, and publish sites
  • Manage and publish site themes
  • Create, register, export, and import custom site components
  • Create, edit, export, and import site templates
  • View and interact with content items in sites
  • Manage and view custom properties and edit values
  • CECEnterpriseUser - Enterprise User
  • Manage content (view, upload, and edit documents)
  • Share content and sites with others
  • Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)
  • Follow people
  • Digital Assets
  • Content Items (editorial content management)
  • Create, manage, view, and interact with content items
  • Collections
  • Create, edit, and publish sites
  • Manage and publish site themes
  • Create, register, export, and import custom site components
  • Create, edit, export, and import site templates
  • Manage and view custom properties and edit values
  • CECExternalUser - External User
Reserved for future use.
  • CECIntegrationUser - Integration User
Used to impersonate another user while performing operations through the Social REST endpoints of the REST API for Collaboration.
  • CECSitesVisitor - Sites Visitor
Access sites restricted to visitors.

Introduced in release 21.10.2.
Show Source
Nested Schema : items
Type: array

Collection of Policy Approvers Member elements.

Introduced in release 19.3.3.
Show Source
Nested Schema : items
Type: object
Show Source

  • Display name for the user, client application or group.

    Introduced in release 19.3.3.
  • group

    Group details of the member. Only available if the member has a type of group.

    Introduced in release 19.3.3.

  • If the member is a group, then the type of group is specified. If the member is a user this field is not present.

    Valid values are:

    • oce - Content management group
    • idp - identity provider group

    Introduced in release 20.1.1.

  • Identifier for the user, client application or group member.

    No assumptions should be made about the content of the field; the field should be treated as an opaque value.

    Introduced in release 19.3.3.

  • Will be set to true if the associated user or client application has only the external user role.

    Introduced in release 21.10.2.

  • Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.

    Introduced in release 19.3.3.

  • Indicates the member is a user, client application or group.

    Valid values are:

    • user - Member is a user or a client application. No distinction is made between a member that is a user or a
    member that is a client application.
    • group - Member is a group

    Introduced in release 19.3.3.
  • user

    User or client application details of the member. Only available if the member has a type of user. A member can be a user, client application or group. The details of both users and client applications can be read.

    Introduced in release 19.3.3.
Nested Schema : group

Group details of the member. Only available if the member has a type of group.

Introduced in release 19.3.3.
Match All
Show Source
  • Group

    A group is a collection of users and groups. A group has a human readable group name.

    Introduced in release 19.3.1.
Nested Schema : user

User or client application details of the member. Only available if the member has a type of user. A member can be a user, client application or group. The details of both users and client applications can be read.

Introduced in release 19.3.3.
Match All
Show Source
  • Identity
    Discriminator: type

    Identity representing a user or client application. The identity contains the common information such as the identity identifier, unique name and display name.

    Introduced in release 20.3.1.
Nested Schema : SiteExpirationPeriod
Type: object

Site expiration is expressed as a unit of time and and an amount. For example, expire a site two months after the site is created.

Introduced in release 19.4.1.
Show Source

  • Amount of time used to measure site expiration.

    Introduced in release 19.4.1.

  • Unit of time used to measure site expiration.

    Valid values are:

    • months - Expiration expressed in the number of months
    • years - Expiration expressed in the number of years

    Introduced in release 19.4.1.
Nested Schema : Repository

Repositories are a storage location for files, both text and images. Repository administrators can create a repository with channel policies and localization policies designated for the repository. Multiple repositories can be created to handle different marketing needs.

A repository can be used to manage all the assets you need in one place. For example, perhaps your company sells computer equipment. One repository could be set up to handle the files related to desktop computers. Another repository could be used for tablets. Each repository might contain photos, graphics, and content about the different kinds of computers. The assets in each repository are controlled by the policies you allocate to the repository.

Match All
Show Source
  • 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.

  • Repository-allOf[1]
Nested Schema : Repository-allOf[1]
Type: object
Show Source
Nested Schema : channels
Type: array

Channels associated with the repository.

Show Source
Nested Schema : contentTypes
Type: array

Content types associated with the repository.

Show Source
Nested Schema : createdDate

Date and time the repository was created.

Match All
Show Source
Nested Schema : languageOptions
Type: array

Language options for the repository.

Show Source
Nested Schema : updatedDate

Date and time the repository was last updated.

Match All
Show Source
Nested Schema : items
Match All
Show Source
Nested Schema : ChannelId
Type: object

Channel identifier.

Show Source

  • Unique identifier for the repository.

    No assumptions should be made about the content of the field; the field should be treated as an opaque value.

  • Short unique human-readable name to identify the channel.

Nested Schema : items
Match All
Show Source
Nested Schema : ContentTypeId
Type: object

Content type identifier.

Show Source
Nested Schema : DateTimeZone
Type: object

Date, time and time zone.

Show Source
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

  • 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

  • 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

Example Response (Batch Read Two Policies)
{
    "batch":[
        {
            "status":{
                "code":200,
                "reason":"OK"
            },
            "headers":[
                {
                    "name":"Content-Type",
                    "value":"application/json"
                }
            ],
            "body":{
                "id":"721af08b-32db-4eee-b6af-0c38d3ba4681",
                "status":"inactive",
                "approvalType":"automatic",
                "accessType":"everyone",
                "security":{
                    "level":"service",
                    "appliesTo":"named"
                },
                "localizationPolicyAllowed":false,
                "sitePrefixAllowed":false,
                "expiration":{
                    "amount":1,
                    "unit":"months"
                },
                "revision":0
            }
        },
        {
            "status":{
                "code":404,
                "reason":"Not Found"
            },
            "headers":[
                {
                    "name":"Content-Type",
                    "value":"application/vnd.oracle.resource+json;type=error"
                }
            ],
            "body":{
                "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
                "title":"Policy Not Found",
                "status":404,
                "detail":"Policy 'bdab2bbf-ebd9-44f4-afe9-e4326bb6211f' does not exist, has been deleted or the authenticated user does not have access to the policy.",
                "o:errorCode":"OCE-SITEMGMT-009022",
                "o:errorDetails":[
                ]
            }
        }
    ]
}

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