The following objects are used in multiple endpoints within the Security API.
Response Body
| Element | Description | Type | Notes |
|---|---|---|---|
| [security_policy_name] | List of elements defined for the named security policy. | array | Examples of some common security policy names include security_clearance and organisational_clearance. |
| engine | The engine, or algorithm, to be used for the security policy. | string | None |
| contentTypes | List of content types or subtypes to which the security policy is automatically applied when a document of that type is created. | array | If the list is empty or null, the security policy is not automatically applied to any content type upon document creation. |
| mixin | The content model mixin to be used to associate relevant documents with the security policy engine. | string | None |
| userAttribute | The user attribute to be used to associate users with the security policy. | string | None |
Sample Response
{
"security_clearance": {
"engine": "securitylevel",
"contentTypes": [
"Contract"
],
"mixin": "Clearance",
"userAttribute": "user_clearance"
}
}