1. REST API for Sites Management
  2. Tasks
  3. Sites
  4. Runtime Access

Grant Access to Site

post

/sites/management/api/v1/sites/{id}/access

COLLECTION

Grant access for a user, client application or group to the site when it goes online. If the site has a security access level that includes named, the user, client application or group specified will have access to the site after they sign in. An invalid user, client application or group error response will be returned if the user, client application or group name does not match a user, client application or group.

Introduced in release 19.4.3.

Authorization

When site governance is enabled, site administrators can grant access to any site. Any user that has been shared with a site can grant access for that site if they have one of the following sharing roles:

  • Owner
  • Manager

Update the Access Levels of a Site

The site must have a security access level that includes named for the user, client application or group specified to have access to the site after they sign in.

For more information, see Update the Fields of a Site.

Path Alternative Identifiers

The default identifier for a Site resource is the Site Identifier. The Site resource supports alternative identifiers.

nameSite Name

Instead of the site identifier, the site name can be used to uniquely identify a site in the resource path. The default resource path parameter for a site is the site identifier, but when working with sites the human-readable site name is sometimes easier.

http://api.example.com/sites/management/api/v1/sites/name:MyNewProduct/access

Introduced in release 19.4.1.

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.

201Created - Grant Access to a User

A user is granted access to the site using the user:username syntax.

Request

POST https://api.example.com/sites/management/api/v1/sites/name:MySite/access

Request Body

{
  "id": "user:jsmith"
}

201Created - Grant Access a User and Send a Welcome Message

A user is granted access to the site using the user:username syntax with a welcome message.

Request

POST https://api.example.com/sites/management/api/v1/sites/name:MySite/access

Request Body

{
  "id": "user:jsmith",
  "message": "You have been given access to the new Acme Product marketing site AcmeProductLaunch. You should be able to view the site after you sign in."
}

201Created - Grant Access to an Application

A client application is granted access to the site using the user:applicationname syntax.

Request

POST https://api.example.com/sites/management/api/v1/sites/name:MySite/access

Request Body

{
  "id": "application:MyProduct_APPID"
}
Introduced in release 20.3.3.

201Created - Grant Access to a Group

A group is granted access to the site using the group:groupname syntax. If both an Oracle Content Management group and Identity Provider group have the same name, the OCE group is used.

Request

POST https://api.example.com/sites/management/api/v1/sites/name:MySite/access

Request Body

{
  "id": "group:marketing",
  "message": "You have been given access to the new Acme Product marketing site AcmeProductLaunch. You should be able to view the site after you sign in."
}

201Created - Grant Access to an Oracle Content Management Group

An Oracle Content Management group is explicitly referenced using the group:oce:groupname syntax.

Request

POST https://api.example.com/sites/management/api/v1/sites/name:MySite/access

Request Body

{
  "id": "group:oce:marketing"
}

201Created - Grant Access to an Identity Provider Group

An identity provider supplied group is explicitly referenced using the group:idp:groupname syntax.

Request

POST https://api.example.com/sites/management/api/v1/sites/name:MySite/access

Request Body

{
  "id": "group:idp:marketing"
}

Client Error Response Examples

This operation responds with following client error (4xx) responses with exception details in the response body. For a full list of response HTTP status codes and example bodies, consult the Response section of this operation.

400Bad Request - Invalid User or Application

A user or client application identified cannot be found.

Error Code

OCE-IDS-001004

Resolution - Check User Exists

Check that the user name is valid.

Resolution - Check Client Application Exists

Check that the client application name is valid.

Exception Detail Fields

This error type includes the following fields/values in the response:

Field NameDescription
userUser or application that does not exist.

For detailed information about this exception detail type, consult the InvalidIdentityExceptionDetail schema in the definitions section of the swagger document.

Example Response Body
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Invalid User or Application",
  "status": "400",
  "detail": "User or client application does not exist.",
  "o:errorCode": "OCE-IDS-001004",
  "user": {
    "id": "1234"
  }
}

Introduced in release 19.3.1.

400Bad Request - Invalid Group

A group identified with an identifier such as the group name cannot be found.

Error Code

OCE-IDS-001007

Resolution - Check Group Exists

Check that the group identifier or group name is valid.

Exception Detail Fields

This error type includes the following fields/values in the response:

Field NameDescription
groupGroup that does not exist.

For detailed information about this exception detail type, consult the InvalidGroupExceptionDetail schema in the definitions section of the swagger document.

Example Response Body
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Invalid Group",
  "status": "400",
  "detail": "Group does not exist.",
  "o:errorCode": "OCE-IDS-001007",
  "group": {
    "id": "1234"
  }
}

Introduced in release 19.3.1.

400Bad Request - Invalid Site Security Access

The security policy on the site means you cannot have the security access levels that have been specified. The security policy specifies the minimum level of security a site can have. For example, when the site security level in the security policy specifies service users, the security access cannot be all cloud users. You cannot publish a site or update site access members when the security access levels of the site are not allowed.

Error Code

OCE-SITEMGMT-009019

Resolution - Change Security Access

Change the site's security access levels to conform to the security policy of the site and retry the operation. When site governance is enabled you can specify security policy on a site by site basis, initially defined by the security policy on the site template that the site was created from. Any site that was created before site governance was enabled will not have a security policy on the site, so will fall back to tenant service level policy. If you get this error you can either set the security policy directly on that site to be public.

Exception Detail Fields

This error type includes the following fields/values in the response:

Field NameDescription
siteSite on which the operation is being performed.

For detailed information about this exception detail type, consult the InvalidSiteSecurityAccessExceptionDetail schema in the definitions section of the swagger document.

Example Response Body
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Invalid Site Security Access",
  "status": "400",
  "detail": "Site security access levels are not allowed by the security policy.",
  "o:errorCode": "OCE-SITEMGMT-009019",
  "site": {
    "id": "FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
  }
}

403Forbidden - Site Operation Forbidden

Your sharing role within the site does not allow you to perform the operation.

Error Code

OCE-SITEMGMT-009026

Resolution - Change the Sharing Role

Change the sharing role given to the authenticated user to the required role or higher.

Resolution - Change the Application Role

Ensure the user has a Standard User or Enterprise User Application Role.

Exception Detail Fields

This error type includes the following fields/values in the response:

Field NameDescription
siteSite on which the operation is being performed.

For detailed information about this exception detail type, consult the SiteOperationForbiddenExceptionDetail schema in the definitions section of the swagger document.

Example Response Body
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Site Operation Forbidden",
  "status": "403",
  "detail": "You do have a sharing role in this site, but your role does not allow you to use this operation.",
  "o:errorCode": "OCE-SITEMGMT-009026",
  "site": {
    "id": "FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
  }
}

Introduced in release 19.1.5.

404Not Found - Site Not Found

The site does not exist or has been deleted, or the authenticated user or client application does not have access to the site.

Error Code

OCE-SITEMGMT-009003

Resolution - Check Identifier

Check that the site identifier is valid.

Resolution - Check Membership

Check that the authenticated user is a member of the site or a site administrator.

Exception Detail Fields

This error type includes the following fields/values in the response:

Field NameDescription
siteSite that does not exist or is not visible to the authenticated user.

For detailed information about this exception detail type, consult the SiteNotFoundExceptionDetail schema in the definitions section of the swagger document.

Example Response Body
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Site Not Found",
  "status": "404",
  "detail": "Site does not exist or has been deleted, or the authenticated user or client application does not have access to the site.",
  "o:errorCode": "OCE-SITEMGMT-009003",
  "site": {
    "id": "FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
  }
}

409Conflict - Site is not a Secure Site

The operation cannot be performed on a site that is not a secure site..

Error Code

OCE-SITEMGMT-009080

Resolution - Change Security Access

Change the site security access from everyone to one or more of the secure site values.

Exception Detail Fields

This error type includes the following fields/values in the response:

Field NameDescription
siteSite on which the operation is being performed.

For detailed information about this exception detail type, consult the SiteNotSecureExceptionDetail schema in the definitions section of the swagger document.

Example Response Body
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Site is not a Secure Site",
  "status": "409",
  "detail": "Operation cannot be performed on a site that is not a secure site.",
  "o:errorCode": "OCE-SITEMGMT-009080",
  "site": {
    "id": "FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
  }
}

Introduced in release 19.4.3.

409Conflict - Member Already Exists

A user, client application or group is already a member.

Error Code

OCE-IDS-001005

Exception Detail Fields

This error type includes the following fields/values in the response:

Field NameDescription
memberMember identifier.

For detailed information about this exception detail type, consult the MemberAlreadyExistsExceptionDetail schema in the definitions section of the swagger document.

Example Response Body
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Member Already Exists",
  "status": "409",
  "detail": "User or group '{member.id}' is already a member'.",
  "o:errorCode": "OCE-IDS-001005",
  "member": {
    "id": "user:jsmith"
  }
}

Introduced in release 19.3.1.

Request

Supported Media Types
Path Parameters
Body ()

Details of the user, client application or group being granted access.

Root Schema : schema
Type: object
Show Source

  • 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.4.3.
  • 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.

  • Maximum Length: 3000

    Message that will be used as part of the notification that site access has been granted.

    Introduced in release 19.4.3.
Example:
{
    "id":"user:jsmith"
}
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
Nested Schema : items
Match All
Show Source
  • Link
Back to Top

Response

Supported Media Types

201 Response

Created
Headers
Body ()
Root Schema : schema
Type: object
Show Source

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

    Introduced in release 19.4.3.
  • group

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

    Introduced in release 19.4.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.4.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.
  • 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.

  • 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.4.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.4.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.4.3.
Nested Schema : group

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

Introduced in release 19.4.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 : 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
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.4.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 : 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 : 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 : 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 : items
Match All
Show Source
  • Link
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
Example Response ()
{
    "id":"user:jsmith",
    "type":"user",
    "name":"jsmith",
    "displayName":"John Smith",
    "isExternalUser":false
}

400 Response

Bad Request
Body ()
Root Schema : schema
Match All
Show Source
Nested Schema : InvalidIdentityExceptionDetail
Introduced in release 19.3.1.
Match All
Show Source
Nested Schema : ExceptionDetail
Type: object

In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such cases, the additional information will be included in the response body.

Show Source
Nested Schema : InvalidIdentityExceptionDetail-allOf[1]
Type: object
Show Source
Nested Schema : o:errorDetails
Type: array

Multiple errors can be organized in a hierarchical structure.

Show Source
Nested Schema : items
Match All
Show Source
  • ExceptionDetail

    In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such cases, the additional information will be included in the response body.

Example Response (Invalid User or Application)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Invalid User or Application",
    "status":"400",
    "detail":"User or client application does not exist.",
    "o:errorCode":"OCE-IDS-001004",
    "user":{
        "id":"1234"
    }
}
Example Response (Invalid Group)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Invalid Group",
    "status":"400",
    "detail":"Group does not exist.",
    "o:errorCode":"OCE-IDS-001007",
    "group":{
        "id":"1234"
    }
}
Example Response (Invalid Site Security Access)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Invalid Site Security Access",
    "status":"400",
    "detail":"Site security access levels are not allowed by the security policy.",
    "o:errorCode":"OCE-SITEMGMT-009019",
    "site":{
        "id":"FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
    }
}

401 Response

Unauthorized

403 Response

Forbidden
Body ()
Root Schema : schema
Match All
Show Source
Nested Schema : SiteOperationForbiddenExceptionDetail
Introduced in release 19.1.5.
Match All
Show Source
Nested Schema : ExceptionDetail
Type: object

In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such cases, the additional information will be included in the response body.

Show Source
Nested Schema : SiteOperationForbiddenExceptionDetail-allOf[1]
Type: object
Show Source
Nested Schema : o:errorDetails
Type: array

Multiple errors can be organized in a hierarchical structure.

Show Source
Nested Schema : items
Match All
Show Source
  • ExceptionDetail

    In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such cases, the additional information will be included in the response body.

Example Response (Site Operation Forbidden)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Site Operation Forbidden",
    "status":"403",
    "detail":"You do have a sharing role in this site, but your role does not allow you to use this operation.",
    "o:errorCode":"OCE-SITEMGMT-009026",
    "site":{
        "id":"FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
    }
}

404 Response

Not Found
Headers
Body ()
Root Schema : schema
Match All
Show Source
Nested Schema : SiteNotFoundExceptionDetail
Match All
Show Source
Nested Schema : ExceptionDetail
Type: object

In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such cases, the additional information will be included in the response body.

Show Source
Nested Schema : SiteNotFoundExceptionDetail-allOf[1]
Type: object
Show Source
Nested Schema : o:errorDetails
Type: array

Multiple errors can be organized in a hierarchical structure.

Show Source
Nested Schema : items
Match All
Show Source
  • ExceptionDetail

    In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such cases, the additional information will be included in the response body.

Example Response (Site Not Found)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Site Not Found",
    "status":"404",
    "detail":"Site does not exist or has been deleted, or the authenticated user or client application does not have access to the site.",
    "o:errorCode":"OCE-SITEMGMT-009003",
    "site":{
        "id":"FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
    }
}

406 Response

Not Acceptable

409 Response

Conflict
Body ()
Root Schema : schema
Match All
Show Source
Nested Schema : SiteNotSecureExceptionDetail
Introduced in release 19.4.3.
Match All
Show Source
Nested Schema : ExceptionDetail
Type: object

In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such cases, the additional information will be included in the response body.

Show Source
Nested Schema : SiteNotSecureExceptionDetail-allOf[1]
Type: object
Show Source
Nested Schema : o:errorDetails
Type: array

Multiple errors can be organized in a hierarchical structure.

Show Source
Nested Schema : items
Match All
Show Source
  • ExceptionDetail

    In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such cases, the additional information will be included in the response body.

Example Response (Site is not a Secure Site)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Site is not a Secure Site",
    "status":"409",
    "detail":"Operation cannot be performed on a site that is not a secure site.",
    "o:errorCode":"OCE-SITEMGMT-009080",
    "site":{
        "id":"FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
    }
}
Example Response (Member Already Exists)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Member Already Exists",
    "status":"409",
    "detail":"User or group '{member.id}' is already a member'.",
    "o:errorCode":"OCE-IDS-001005",
    "member":{
        "id":"user:jsmith"
    }
}

413 Response

Payload Too Large

415 Response

Unsupported Media Type

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