REST API Reference

Back Next

Updating a role

You can add or remove privileges for custom roles.

Add privileges

To add privileges to a custom role, send a PUT request using one of the following URIs:

/public/core/v3/roles/<role ID>/addPrivileges

/public/core/v3/roles/name/<role name>/addPrivileges

Include an array of privilege names for the custom role.

For example, to give a role create and delete privileges for data transfer tasks, you might use the following request:

PUT <baseApiUrl>/public/core/v3/roles/cPYWk02I4aBeuLEvYRtaMS/addPrivileges
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>
{
    "privileges" : ["create.data.transfer.task", "delete.data.transfer.task"]
}

You can use the privileges resource to get a list of privilege names that you can use. For more information, see Privileges.

Remove privileges

To remove privileges from a custom role, send a PUT request using one of the following URIs:

/public/core/v3/roles/<role ID>/removePrivileges

/public/core/v3/roles/name/<role name>/removePrivileges

You can't remove all of the privileges from a role. A role must have at least one privilege assigned to it.

Include an array of privilege names to remove for the custom role.

For example, to remove create and delete privileges for API collection from a role, you might use the following request:

PUT <baseApiUrl>/public/core/v3/roles/cPYWk053KnrUerLvYRtaMS/removePrivileges
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>
{
    "privileges" : ["create.api.collection", "delete.api.collection"]
}

Roles

Download Guide

Watch

Comments

Cloud B2B Gateway Homepage