REST API Reference

Back Next

Getting permission details

You can get permission details for particular ACL ID or get the details for all permissions on an object.

GET request

To get the details for a particular ACL ID, send a GET request using the following URI:

/public/core/v3/objects/<object ID>/permissions/<ACL ID>

To get the details for all permissions on an object, send a GET request using the following URI:

/public/core/v3/objects/<object ID>/permissions

GET response

If successful, returns the following information for an ACL ID:

Field	Type	Description
id	String	ACL ID
principal	Object	Information about the user or group.
type	String	Whether the principal is a user or group.
name	String	User name or name of the user group.
permissions	Object	Object permissions for the user or group.
read	Boolean	Whether the user or group can view the object.
update	Boolean	Whether the user or group can update the object.
delete	Boolean	Whether the user or group can delete the object.
execute	Boolean	Whether the user or group can run the task.
changePermission	Boolean	Whether the user or group can change the permissions for the object.

Get example

To get the details for all permissions on a object, you might send a request that's similiar to the following example:

/public/core/v3/objects/2ymkhUZCl7XbUmN7dsq6Wc/permissions

You might receive a response similar to the following example:


[
    {
        "id": "4D6ER3yic8cjjE1GmxEKEi",
        "principal": {
            "type": "USER",
            "name": "saki@infa.com"
        },
        "permissions": {
            "read": true,
            "update": true,
            "delete": true,
            "execute": true,
            "changePermission": true
        }
    },
    {
        "id": "6g51tCtEX08bldfh8k6cgz",
        "principal": {
            "type": "GROUP",
            "name": "Everyone"
        },
        "permissions": {
            "read": false,
            "update": true,
            "delete": true,
            "execute": false,
            "changePermission": true
        }
    }
]

Object permissions

Download Guide

Watch

Comments

Cloud B2B Gateway Homepage