Get segment or folder permissions
Learn more about getting the access control list for a segment or folder.
The Get segment or folder permissions retrieves the role-based access control list (ACL) for a segment or folder. The ACL maps role names to an access level (READ or WRITE). WRITE includes READ. If the segment or folder has no ACL, the response returns an empty object.
HTTP method and endpoint
Use the following HTTP method and endpoint path to get the permissions for a segment or folder.
GET {envUri}/reltio/api/{tenantId}/segments/{id}/_permissionsThe following table describes the endpoint path parameters.
| Parameter | Type | Required | Description |
|---|---|---|---|
tenantId | String | Yes | Unique identifier of the tenant. |
id | String | Yes | Unique identifier of the segment or folder. |
Request headers
The following request headers must be included.
| Header | Value | Required |
|---|---|---|
Authorization | Bearer <access_token> | Yes |
Request body
This operation does not require a request body.
Example request
Use the following example to get the permissions for a segment or folder.
GET {envUri}/reltio/api/{tenantId}/segments/{id}/_permissionsResponse body
The following table describes the fields returned in the response body.
| Field | Type | Description |
|---|---|---|
| (root object) | Object | A map of role name to access level. Each key is a role name; each value is READ or WRITE. If the segment or folder has no ACL, the API returns {}.. |
Example response
The following example shows a response for a segment with a role-based ACL.
{
"ROLE_SALES": "READ",
"ROLE_MKT": "WRITE"
}Error codes and recommended actions
The following table lists the possible error responses returned by this API.
| HTTP status | Error code | Description | Recommended action |
|---|---|---|---|
403 Forbidden | SEGMENT_FORBIDDEN | The caller does not have READ access to the segment or folder, or to one of its ancestor folders. | Request READ access from the segment or folder owner, or from a tenant admin. |
404 Not Found | SEGMENT_NOT_FOUND | The segment or folder with the specified ID does not exist. | Verify the segment or folder ID, and then retry the request. |