Unshare a Theme
/sites/management/api/v1/themes/{id}/members/{memberId}
Remove a single user, client application or group member from the members list. If the user, client application or group is not a member of the members list then a member not found error is returned in the response.
Introduced in release 19.4.1.
Authorization
To invoke this operation, the authenticated user or client application must have been shared with the resource and have one of the following sharing roles:
- Owner
- Manager
Leaving the Theme
A user can remove themselves from the theme by using the leave extended operation.
For more information, see Leave the Theme.
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.
204No Content - Unshare a User
Remove user jsmith
as a member of this theme.
Request
DELETE https://api.example.com/sites/management/api/v1/themes/name:MyTheme/members/user:jsmith
204No Content - Unshare an Application
Remove client application MyProductAPPID
as a member of this theme.
Request
DELETE https://api.example.com/sites/management/api/v1/themes/name:MyTheme/members/user:MyProduct_APPIDIntroduced in release 20.3.3.
204No Content - Unshare a Group
Remove group marketing
as a member of this theme.
Request
DELETE https://api.example.com/sites/management/api/v1/themes/name:MyTheme/members/group: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 - Owner Member Read-Only
The owner member is read-only and can't be modified.
Error Code
OCE-DOCS-001004
Resolution - Do Not Leave
An owner cannot leave a resource they own. You can only leave a resource if that resource has been shared with you.
Resolution - Do Not Delete
An owner cannot be removed as a member.
Resolution - Do Not Change Role
The role for an owner cannot be changed.
Example Response Body
{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", "title": "Owner Member Read-Only", "status": "400", "detail": "The operation cannot be performed as the user is the owner of the resource.", "o:errorCode": "OCE-DOCS-001004" }
Introduced in release 19.4.1.
403Forbidden - Theme Operation Forbidden
Your sharing role within the theme does not allow you to perform the operation.
Error Code
OCE-SITEMGMT-009054
Resolution - Change the Sharing Role
Change the sharing role given to the authenticated user to the required role or higher.
Exception Detail Fields
This error type includes the following fields/values in the response:
Field Name | Description |
theme | Theme on which the operation is being performed. |
For detailed information about this exception detail type, consult the ThemeOperationForbiddenExceptionDetail 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": "Theme Operation Forbidden", "status": "403", "detail": "You do have a sharing role in this theme, but your role does not allow you to use this operation.", "o:errorCode": "OCE-SITEMGMT-009054", "theme": { "id": "FFA7758925559C7F6FC394910D5DDCD9211A3DB216EC" } }
Introduced in release 19.4.1.
404Not Found - Member Not Found
The user, client application or group is not a member.
Error Code
OCE-IDS-001003
Exception Detail Fields
This error type includes the following fields/values in the response:
Field Name | Description |
member | User, application or group that is not a member. |
For detailed information about this exception detail type, consult the MemberNotFoundExceptionDetail 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 Not Found", "status": "404", "detail": "User, application or group '{member.id}' is not a member'.", "o:errorCode": "OCE-IDS-001003", "member": { "id": "user:jsmith" } }
Introduced in release 19.3.1.
Request
-
id: string
Immutable identifier for the theme.
-
memberId: string
Identifier for the user, client application or group member.
Response
204 Response
400 Response
-
allOf
OwnerMemberReadOnlyExceptionDetail
Introduced in release 19.4.1.
-
object
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.
-
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.
-
detail(optional):
string
Description specific to this occurrence of the problem. The human-readable, potentially multi-line details describing the problem in more details.
-
instance(optional):
string(uri)
URI to the link that provides more detail about the error.
-
o:errorCode(optional):
string
Application error code, which is different from HTTP error code. This code should be used to check for specific errors, rather than comparing fields such as the
title
ordetail
. -
o:errorDetails(optional):
array o:errorDetails
Multiple errors can be organized in a hierarchical structure.
-
o:errorPath(optional):
string
XPath or JSON path to indicate where the error occurs.
-
status(optional):
integer(int32)
Corresponding HTTP status code for the error.
-
title(optional):
string
Short, human-readable summary of the problem. It is not advisable to use the title as a way of checking for specific errors, use the
o:errorCode
for this purpose. -
type(optional):
string(uri)
Absolute URI that identifies the problem type. When this URI dereferenced, it should provide a human-readable summary of the problem, for example, as a HTML page.
array
Multiple errors can be organized in a hierarchical structure.
-
object
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.
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Owner Member Read-Only",
"status":"400",
"detail":"The operation cannot be performed as the user is the owner of the resource.",
"o:errorCode":"OCE-DOCS-001004"
}
401 Response
403 Response
-
allOf
ThemeOperationForbiddenExceptionDetail
Introduced in release 19.4.1.
-
object
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.
-
object
ThemeOperationForbiddenExceptionDetail-allOf[1]
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.
-
detail(optional):
string
Description specific to this occurrence of the problem. The human-readable, potentially multi-line details describing the problem in more details.
-
instance(optional):
string(uri)
URI to the link that provides more detail about the error.
-
o:errorCode(optional):
string
Application error code, which is different from HTTP error code. This code should be used to check for specific errors, rather than comparing fields such as the
title
ordetail
. -
o:errorDetails(optional):
array o:errorDetails
Multiple errors can be organized in a hierarchical structure.
-
o:errorPath(optional):
string
XPath or JSON path to indicate where the error occurs.
-
status(optional):
integer(int32)
Corresponding HTTP status code for the error.
-
title(optional):
string
Short, human-readable summary of the problem. It is not advisable to use the title as a way of checking for specific errors, use the
o:errorCode
for this purpose. -
type(optional):
string(uri)
Absolute URI that identifies the problem type. When this URI dereferenced, it should provide a human-readable summary of the problem, for example, as a HTML page.
object
-
theme(optional):
string
Theme on which the operation is being performed.
Introduced in release 19.4.1.
array
Multiple errors can be organized in a hierarchical structure.
-
object
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.
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Theme Operation Forbidden",
"status":"403",
"detail":"You do have a sharing role in this theme, but your role does not allow you to use this operation.",
"o:errorCode":"OCE-SITEMGMT-009054",
"theme":{
"id":"FFA7758925559C7F6FC394910D5DDCD9211A3DB216EC"
}
}
404 Response
-
Cache-Control: string
Directives for caching mechanisms.
-
Content-Length: string
Size of the response body.
-
Content-Type: string
Content type of the response.
-
allOf
MemberNotFoundExceptionDetail
Introduced in release 19.3.1.
-
object
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.
-
object
MemberNotFoundExceptionDetail-allOf[1]
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.
-
detail(optional):
string
Description specific to this occurrence of the problem. The human-readable, potentially multi-line details describing the problem in more details.
-
instance(optional):
string(uri)
URI to the link that provides more detail about the error.
-
o:errorCode(optional):
string
Application error code, which is different from HTTP error code. This code should be used to check for specific errors, rather than comparing fields such as the
title
ordetail
. -
o:errorDetails(optional):
array o:errorDetails
Multiple errors can be organized in a hierarchical structure.
-
o:errorPath(optional):
string
XPath or JSON path to indicate where the error occurs.
-
status(optional):
integer(int32)
Corresponding HTTP status code for the error.
-
title(optional):
string
Short, human-readable summary of the problem. It is not advisable to use the title as a way of checking for specific errors, use the
o:errorCode
for this purpose. -
type(optional):
string(uri)
Absolute URI that identifies the problem type. When this URI dereferenced, it should provide a human-readable summary of the problem, for example, as a HTML page.
object
-
member(optional):
string
User, application or group that is not a member.
Introduced in release 19.3.1.
array
Multiple errors can be organized in a hierarchical structure.
-
object
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.
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Member Not Found",
"status":"404",
"detail":"User, application or group '{member.id}' is not a member'.",
"o:errorCode":"OCE-IDS-001003",
"member":{
"id":"user:jsmith"
}
}