Return the Effective ACLs on the Specified Document - Hyland Content REST API - Current - Current - Ready - Content Innovation Cloud - external

Hyland Content REST API
Platform
Content Innovation Cloud
Product
Hyland Content REST API
Release
Current
License

Returns the full, effective ACLs for the given list of users on the specified document.

Base Request

GET /api/documents/[docId]/fulleffectiveacl

where [docId] is the alphanumeric ID for the document.

Query Parameters

Parameter Description Type Required Notes
usernames List of the user IDs whose corresponding user ACLs for the specified document will be retrieved. array Optional If no user value is provided, all effective ACLs on the specified document are returned (with no filtering for specific users).

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

Sample Request

GET /api/documents/[docId]/fulleffectiveacl?usernames=['ff7b0360-3594-416c-b587-2fa4dd0839ce', 'ff7dr360-3594-616c-b587-2fa4dd0acdfce']

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

Response Body

Element Description Type Notes
fullEffectiveACL A pseudo-list giving access to the full, effective ACLs on the document and accounting for inheritance from the parents. array None
userId Alphanumeric ID for the current user within the ACL. string None
userAcl A pseudo-list giving access to the ACLs for the current user. array The ACLs need to specify three types of values::
  • User or group
  • Permission or permission group
  • Grant or deny (Boolean)

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

Sample Response

{
  "sys_id": "string",
  "fullEffectiveACL": [
    {
      "userId": "string",
      "userAcl": [
        {
          "creator": "string",
          "permission": "string",
          "granted": true,
          "user": {
            "id": "string",
            "firstName": "string",
            "lastName": "string",
            "email": "string"
          },
          "group": {
            "id": "string",
            "name": "string"
          },
          "end": "2022-03-10T16:15:50Z",
          "begin": "2022-03-10T16:15:50Z",
          "status": "PENDING"
        }
      ]
    }
  ]
}

Status Codes and Errors

The following table lists the returned status codes.

Code Description Notes
200 OK Returns the full, effective ACLs for the given list of users on the specified document.
401 Not Authorized Authentication has failed or was not provided.
403 Not Allowed Access permissions are invalid or missing.
404 Not Found The document could not be found.