REST API for Sites Management

Get an Example Request Body for Creating Policy Access Member Resources

get

/sites/management/api/v1/policies/{id}/access/create-form

CREATE FORM

Get a template request body suitable for creating a new policy access member.The create-form resource provides an example request body that clients can use as a template when creating a new Policy Access Member. The example request body property values can be edited, removed or added to and then used as the request body when creating a Policy Access Member. Use of the create form is optional, it is only provided as a guide to the request body format.

Introduced in release 19.3.1.

Authorization

To access this create-form resource requires read access to the parent resource.

For more information, see Get Policy Details

Enabling the Access List

The access list is only used if the accessType of the associated policy is set to restricted. If the access type is set to everyone the members of the access list are ignored. However, it is valid to alter the access list members when the policy access type is set to everyone.

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

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 - Add User

A user is added using the user:username syntax.

Request

GET https://api.example.com/sites/management/api/v1/policies/{id}/access/create-form

Response Body

"user:jsmith"

200OK - Add Application

A client application is added using the user:applicationname syntax.

Request

GET https://api.example.com/sites/management/api/v1/policies/{id}/access/create-form

Response Body

"application:MyProduct_APPID"

Introduced in release 20.3.3.

200OK - Add Group

A group is added 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

GET https://api.example.com/sites/management/api/v1/policies/{id}/access/create-form

Response Body

"group:marketing"

200OK - Add Oracle Content Management Group

An Oracle Content Management group is referenced using the group:oce:groupname syntax. If there is a name clash between an OCE group and an identity provider group this syntax can be used to be explicit about the type of group being added.

Request

GET https://api.example.com/sites/management/api/v1/policies/{id}/access/create-form

Response Body

"group:oce:marketing"

200OK - Add Identity Provider Group

An identity provider supplied group is referenced using the group:idp:groupname syntax. If there is a name clash between an Oracle Content Management group and an IDP group this syntax can be used to be explicit about the type of group being added.

Request

GET https://api.example.com/sites/management/api/v1/policies/{id}/access/create-form

Response Body

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

404Not Found - Policy Not Found

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

Error Code

OCE-SITEMGMT-009022

Resolution - Check Identifier

Check that the policy identifier is valid.

Resolution - Check Role

Check that the authenticated user is a site administrator.

Resolution - Check Access

If the user is not a site administrator then check the policy 'accessType' includes the authenticated user.

Exception Detail Fields

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

Field Name	Description
`policy`	Policy that does not exist or is not visible to the authenticated user.

For detailed information about this exception detail type, consult the PolicyNotFoundExceptionDetail 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": "Policy Not Found",
  "status": "404",
  "detail": "Policy does not exist or has been deleted, or the authenticated user or client application does not have access to the policy.",
  "o:errorCode": "OCE-SITEMGMT-009022",
  "policy": {
    "id": "721af08b-32db-4eee-b6af-0c38d3ba4681"
  }
}

Request

Path Parameters

id: string

Globally unique identifier for a policy.

Query Parameters

excludeFields(optional): string

Comma-delimited string of field names that should not be included in the response.
excludeLinks(optional): string

Comma-separated list of link relation names to exclude from the response.
fields(optional): string

Comma-delimited string of field names to include 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.

links(optional): string

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 Relationship	Description
`parent`	Describes 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.
`self`	Describes 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.
`canonical`	Describes 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.
`create`	Describes where the resource can be created. Used on collection resources to indicate where a post can be performed to create a new resource in the collection.
`describedBy`	Describes 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.

Response

Supported Media Types

application/json
application/vnd.oracle.resource+json;type=create-form

200 Response

Headers

Cache-Control: string

Directives for caching mechanisms.
Content-Length: string

Size of the response body.
Content-Type: string

Content type of the response.
ETag: string

Opaque identifier assigned by the origin server to a specific version of a resource.

Root Schema : schema

Type: object

Show Source

id: string

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.
links(optional): array 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.

{
    "type":"object",
    "properties":{
        "links":{
            "description":"<p>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.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/Link"
                    }
                ]
            }
        },
        "id":{
            "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.1.</small>",
            "x-opaque":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"string"
        }
    },
    "required":[
        "id"
    ]
}

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

Array of: items

{
    "description":"<p>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.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/Link"
            }
        ]
    }
}

Nested Schema : items

Match All

Show Source

object Link

REST HATEOAS link and related metadata. If responses provide links (for example, a self link to the resource itself) the links provided will include one or more of the properties defined on this link structure.

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

Nested Schema : Link

Type: object

REST HATEOAS link and related metadata. If responses provide links (for example, a self link to the resource itself) the links provided will include one or more of the properties defined on this link structure.

Show Source

href(optional): string

The target resource URI. URI RFC3986 or URI Template RFC6570. If the value is set to URI Template, then the templated property must be set to true.
mediaType(optional): string

Media type, as defined by RFC 2046, describing the link target.
method(optional): string
HTTP method for requesting the target of the link.
Valid values are:
- OPTIONS - HTTP OPTIONS
- HEAD - HTTP HEAD
- GET - HTTP GET
- POST - HTTP POST
- PUT - HTTP PUT
- PATCH - HTTP PATCH
- DELETE - HTTP DELETE
profile(optional): string(uri)

Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource.
rel(optional): string

Name of the link relation that, in addition to the type property, can be used to retrieve link details.
templated(optional): boolean

Boolean flag that specifies the href property is a URI or URI Template. The property can be assumed to be false if the property is not present.

{
    "description":"<p>REST HATEOAS link and related metadata. If responses provide links (for example, a <code>self</code> link to the resource itself) the links provided will include one or more of the properties defined on this link structure.</p>",
    "properties":{
        "rel":{
            "description":"<p>Name of the link relation that, in addition to the type property, can be used to retrieve link details.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "href":{
            "description":"<p>The target resource URI. URI <em>RFC3986</em> or URI Template <em>RFC6570</em>. If the value is set to URI Template, then the <code>templated</code> property must be set to <code>true</code>.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "templated":{
            "description":"<p>Boolean flag that specifies the <code>href</code> property is a URI or URI Template. The property can be assumed to be <code>false</code> if the property is not present.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "mediaType":{
            "description":"<p>Media type, as defined by RFC 2046, describing the link target.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "method":{
            "description":"<p>HTTP method for requesting the target of the link.</p><p>Valid values are:\n<ul><li> <code>OPTIONS</code> - HTTP OPTIONS</li><li> <code>HEAD</code> - HTTP HEAD</li><li> <code>GET</code> - HTTP GET</li><li> <code>POST</code> - HTTP POST</li><li> <code>PUT</code> - HTTP PUT</li><li> <code>PATCH</code> - HTTP PATCH</li><li> <code>DELETE</code> - HTTP DELETE</li></p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "profile":{
            "description":"<p>Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"uri"
        }
    }
}

Example Response (Add User)

"user:jsmith"

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.

Root Schema : schema

Match All

Show Source

allOf PolicyNotFoundExceptionDetail

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

Nested Schema : PolicyNotFoundExceptionDetail

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

{
    "description":"",
    "allOf":[
        {
            "$ref":"#/definitions/ExceptionDetail"
        },
        {
            "properties":{
                "policy":{
                    "description":"<p>Policy that does not exist or is not visible to the authenticated user.</p>",
                    "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 : PolicyNotFoundExceptionDetail-allOf[1]

Type: object

Show Source

policy(optional): string

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

{
    "properties":{
        "policy":{
            "description":"<p>Policy that does not exist or is not visible to the authenticated user.</p>",
            "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 (Policy Not Found)

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Policy Not Found",
    "status":"404",
    "detail":"Policy does not exist or has been deleted, or the authenticated user or client application does not have access to the policy.",
    "o:errorCode":"OCE-SITEMGMT-009022",
    "policy":{
        "id":"721af08b-32db-4eee-b6af-0c38d3ba4681"
    }
}

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