REST API Reference

Back Next

Creating permissions

Create an access control list (ACL) for each user or user group and object pair.

POST request

To create an ACL, send a POST request using the following URI:

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

Include the following information:

Field	Type	Required	Description
principal	Object	Yes	Whether the ACL is defined for a user or user group and the name of the user or user group.
type	String	Yes	Include in principal object. Use one of the following values: USER GROUP
name	String	Yes	Include in principal object. Name of the object.
permissions	Object	Yes	Object permissions to assign to the user or group.
read	Boolean	Yes	Include in permissions object. Whether to allow the user or group to view the object.
delete	Boolean	Yes	Include in permissions object. Whether to allow the user or group to delete the object.
execute	Boolean	Yes	Include in permissions object. Whether to allow the user to run the task.
changePermission	Boolean	Yes	Include in permissions object. Whether to allow the user or group to change the permissions for the object.

POST response

If successful, returns the object with the details you included in the POST request plus the ACL ID.

POST example

To create user permissions for an object, you might send a request similar to the following example:

POST <baseApiUrl>/public/core/v3/objects/9EcgvBYZ9GGflOYr98GzOH/permissions
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>
{
    "principal": {
        "type":"USER",
        "name":"larry@infa.com"
    },
    "permissions" : {
        "read" : true,
        "update" : true,
        "delete" : true,
        "execute" : true,
        "changePermission" : true
    }
}

You might receive a response similar to the following example:

[
    {
        "id": "0dXigiEiWRbb5rKLgPfFCe",
        "principal": {
            "type": "USER",
            "name": "larry@infa.com"
        },
        "permissions": {
            "read": true,
            "update": true,
            "delete": true,
            "execute": true,
            "changePermission": true
        }
    }
]

Object permissions

Download Guide

Watch

Comments

Cloud Data Integration Homepage