Jump to

• Request
• Response

Batch Unshare Users, Applications or Groups

delete

/sites/management/api/v1/themes/{id}/members

COLLECTION

Unshare one or more users, applications or groups that this theme has been shared with. Member identifiers are specified using the memberId query parameter; unsharing one or more users, applications or groups in a single request.

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

Batching

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

Path Alternative Identifiers

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

nameTheme Name

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

http://api.example.com/sites/management/api/v1/themes/name:LearnTheme/members

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 - Unshare a User and a Group

Remove user jsmith and group marketing from theme MyTheme.

Request

DELETE https://api.example.com/sites/management/api/v1/themes/name:MyTheme/members?memberId=user:jsmith,group:marketing

204No Content - Unshare a Client Application

Remove client application MyProductAPPID from theme MyTheme.

Request

DELETE https://api.example.com/sites/management/api/v1/themes/name:MyTheme/members?memberId=user:MyProduct_APPID

Introduced in release 20.3.3.

204No Content - Unshare Multiple Groups

Remove groups engineering and marketing from theme MyTheme.

Request

DELETE https://api.example.com/sites/management/api/v1/themes/name:MyTheme/members?memberId=group:engineering,group:marketing

204No Content - Unshare Multiple Users

Remove users jsmith1 and jsmith2 from theme MyTheme.

Request

DELETE https://api.example.com/sites/management/api/v1/themes/name:MyTheme/members?memberId=user:jsmith1,user:jsmith2

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.

404Not Found - Theme Not Found

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

Error Code

OCE-SITEMGMT-009041

Resolution - Check Identifier

Check that the theme identifier is valid.

Resolution - Check Membership

Check that the authenticated user is a member of the theme.

Exception Detail Fields

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

Field Name	Description
theme	Theme that does not exist or is not visible to the authenticated user.

For detailed information about this exception detail type, consult the ThemeNotFoundExceptionDetail 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 Not Found",
  "status": "404",
  "detail": "Theme does not exist or has been deleted, or the authenticated user or client application does not have access to the theme.",
  "o:errorCode": "OCE-SITEMGMT-009041",
  "theme": {
    "id": "FFA7758925559C7F6FC394910D5DDCD9211A3DB216EC"
  }
}

Introduced in release 19.4.1.

Request

Path Parameters

• id: string

  Immutable identifier for the theme.

Query Parameters

• memberId(optional): string

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

Back to Top

Response

Supported Media Types

• application/json

204 Response

No Content

400 Response

Bad Request

401 Response

Unauthorized

403 Response

Forbidden

404 Response

Not Found

Headers

• Cache-Control: string

  Directives for caching mechanisms.

• Content-Length: string

  Size of the response body.

• Content-Type: string

  Content type of the response.

Body ()

Root Schema : schema

Match All

Show Source

• allOf ThemeNotFoundExceptionDetail
  Introduced in release 19.4.1.

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

Nested Schema : ThemeNotFoundExceptionDetail

Introduced in release 19.4.1.

Match All

Show Source

• 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 ThemeNotFoundExceptionDetail-allOf[1]

{
    "description":"<small>Introduced in release 19.4.1.</small>",
    "allOf":[
        {
            "$ref":"#/definitions/ExceptionDetail"
        },
        {
            "properties":{
                "theme":{
                    "description":"<p>Theme that does not exist or is not visible to the authenticated user.</p><small>Introduced in release 19.4.1.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                }
            }
        }
    ]
}

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

• 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 or detail.

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

{
    "description":"<p>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.</p>",
    "properties":{
        "type":{
            "description":"<p>Absolute URI that identifies the problem type. When this URI dereferenced, it <strong>should</strong> provide a human-readable summary of the problem, for example, as a HTML page.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"uri"
        },
        "title":{
            "description":"<p>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 <code>o:errorCode</code> for this purpose.</p>",
            "x-multiLingual":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "status":{
            "description":"<p>Corresponding HTTP status code for the error.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"integer",
            "format":"int32"
        },
        "detail":{
            "description":"<p>Description specific to this occurrence of the problem. The human-readable, potentially multi-line details describing the problem in more details.</p>",
            "x-multiLingual":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "instance":{
            "description":"<p>URI to the link that provides more detail about the error.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"uri"
        },
        "o:errorCode":{
            "description":"<p>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 <code>title</code> or <code>detail</code>.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "o:errorPath":{
            "description":"<p>XPath or JSON path to indicate where the error occurs.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "o:errorDetails":{
            "description":"<p>Multiple errors can be organized in a hierarchical structure.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/ExceptionDetail"
                    }
                ]
            }
        }
    }
}

Nested Schema : ThemeNotFoundExceptionDetail-allOf[1]

Type: object

Show Source

• theme(optional): string

  Theme that does not exist or is not visible to the authenticated user.

  Introduced in release 19.4.1.

{
    "properties":{
        "theme":{
            "description":"<p>Theme that does not exist or is not visible to the authenticated user.</p><small>Introduced in release 19.4.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        }
    }
}

Nested Schema : o:errorDetails

Type: array

Multiple errors can be organized in a hierarchical structure.

Show Source

• Array of: items

{
    "description":"<p>Multiple errors can be organized in a hierarchical structure.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/ExceptionDetail"
            }
        ]
    }
}

Nested Schema : items

Match All

Show Source

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

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

Example Response (Theme Not Found)

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

409 Response

Conflict

413 Response

Payload Too Large

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