Leave the Component
/sites/management/api/v1/components/{id}/members/leave
If a user or client application has a sharing role in the component the user or client application can leave the component.
Introduced in release 19.4.1.
Sharing
Any user or client application that is shared with the component can leave. The owner cannot leave.
Path Alternative Identifiers
The default identifier for a Component resource is the Component Identifier. The Component resource supports alternative identifiers.
nameComponent Name
Instead of the component identifier, the component name can be used to uniquely identify a component in the resource path. The default resource path parameter for a component is the component identifier, but when working with components the human-readable component name is sometimes easier.
http://api.example.com/sites/management/api/v1/components/name:FooterBar/members/leave
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.
204No Content - User or Application has Left the Component
If the user or client application has left the component a no content response code is returned.
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.
404Not Found - Component Not Found
The site component does not exist or has been deleted, or the authenticated user or client application does not have access to the component.
Error Code
OCE-SITEMGMT-009045
Resolution - Check Identifier
Check that the component identifier is valid.
Resolution - Check Membership
Check that the authenticated user is a member of the component.
Exception Detail Fields
This error type includes the following fields/values in the response:
Field Name | Description |
component | Component that does not exist or is not visible to the authenticated user. |
For detailed information about this exception detail type, consult the ComponentNotFoundExceptionDetail 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": "Component Not Found", "status": "404", "detail": "Component does not exist or has been deleted, or the authenticated user or client application does not have access to the component.", "o:errorCode": "OCE-SITEMGMT-009045", "component": { "id": "F40B9BE3E69F6DC440559A1F033BB2482DB740ECB2D8" } }
Introduced in release 19.4.1.
Request
-
id: string
Immutable identifier for the component.
-
includeDeleted(optional): boolean
Resources that have been marked for deletion can be read, modified, and support extended operations as long this query parameter is set to
true
. When theincludeDeleted
query parameter is not sent then the response to read, modification, and extended operations will be identical to that which would be returned if the resource was permanently deleted.
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
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
ComponentNotFoundExceptionDetail
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
ComponentNotFoundExceptionDetail-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
-
component(optional):
string
Component that does not exist or is not visible to the authenticated user.
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":"Component Not Found",
"status":"404",
"detail":"Component does not exist or has been deleted, or the authenticated user or client application does not have access to the component.",
"o:errorCode":"OCE-SITEMGMT-009045",
"component":{
"id":"F40B9BE3E69F6DC440559A1F033BB2482DB740ECB2D8"
}
}