Update the Security Policies for the Specified Project ID - Content REST API - Current - Current - Ready - Hyland Experience - external

Hyland Experience Content REST API
Platform
Hyland Experience
Product
Content REST API
Release
Current
License

Updates the security policies specific to projects in the content model for the repository.

Note: The server ignores any security policies in the request that have the same name as either a system-wide security policy or a security policy for another project.

Base Request

PUT /api/repository/security/policies/project/[projectId]

where [projectId] is the alphanumeric ID for the project.

Query Parameters

Parameter Description Type Required Notes
validateOnly True/false indicator of only validating security policy changes without applying them. Boolean Optional Default is false.

Headers

Header Name Description Required Values
Authorization The access token Required Bearer [access_token]

where [access_token] is a string generated when you complete authentication (see Getting Started)
User-Agent Identity of the client making the request to the server Required [product]/[version]

where [product] is the name of the software you are using to make the request and [version] is the numbered version of the software (for example, MyCompanyProduct/1.0).

For information on other types of values commonly included in user-agent request headers, see the User-Agent HTTP header reference section on the Mozilla developer documentation website.
HXCS-REPOSITORY The repository ID Optional Any contributed repository name. Default is default.
Accept The format of the data to be returned Optional application/vnd.hxcs.v1+json
Content-Type The format of the data to be posted Optional application/json

Request Body

The request body follows the same structure as the response body, only the request body does not require the projectId element.

Sample Request

PUT /api/repository/security/policies/project/[projectId]?validateOnly=true

Authorization: Bearer [access_token]
User-Agent: MyCompanyProduct/1.0
HXCS-REPOSITORY: default
Accept: application/vnd.hxcs.v1+json
Content-Type: application/json

{
  "organisational_clearance": {
    "engine": "securitylevel",
    "contentTypes": [
      "Invoice"
    ],
    "mixin": "Organisation",
    "userAttribute": "rank"
  }
}

Response Body

Element Description Type Notes
projectId Alphanumeric ID of the project string This value is included as a path parameter in the request.

See Security for more information on the additional, more common elements listed in the body of the following sample response.

Sample Response

{
  "organisational_clearance": {
    "engine": "securitylevel",
    "projectId": "12345",
    "contentTypes": [
      "Invoice"
    ],
    "mixin": "Organisation",
    "userAttribute": "rank"
  }
}

Status Codes and Errors

The following table lists the returned status codes.

Code Description Notes
200 OK Sets the security policies specific to projects in the existing content model and returns the model for the repository.
204 No Content The provided security policies are valid and can be applied.
401 Not Authorized Authentication has failed or was not provided.
403 Not Allowed Access permissions are invalid or missing.
404 Not Found The repository could not be found.
422 Unprocessable Entity Updates to the repository have failed due to a validation error.