setPermissionsByRole

Purpose

Sets the permissions for the specified role on the specified entity and returns a status.

HTTP Method

POST

URL

https://app.infiniteblue.com/rest/api/setPermissionsByRole

URL Parameters

sessionId

The session ID obtained from the body of the response when calling login.

roleId

The original ID of the role.

entityType

The type of entity for which permissions should be set. Can be one of the following: field, object, application, menu, view, action, report, chart.

entityId

The original ID of the entity for which permissions are to be set.

permissions

A comma-separated list of the permissions to set for the entity. Can be any of the following values: view, create, edit, delete, login. An empty value clears all permissions on the entity for that role. To grant edit permission on an entity, you must also grant view permission. You can set login only on a master tenant when entityType is object and entityId evaluates to Customer. Note that when entityType is application, menu, view, action, report, or chart, the only valid permission is view.

viewConditionScript

When granting conditional permission for view access, the condition formula as a base64-encoded string. To grant conditional view permission, the permissions parameter must include view. This parameter only applies to field-level permissions.

editConditionScript

When granting conditional permission for edit access, the condition formula as a base64-encoded string. To grant conditional edit permission, the permissions parameter must include view and edit. This parameter only applies to field-level permissions.

output

Optional parameter specifying the output format, one of: xml (default) or json.

Permissions Required

Full administrative privileges.

Response

The status in XML or JSON format.

Example

Output example in XML format:

<?xml version="1.0" encoding="UTF-8" ?>

<resp status="ok">
</resp>