Sign in
Permission Sets

List permission sets

Users that have the global permission Manage Permission Sets get the full details, including the available operations.

Required Permissions

  • Global (At least 1 of the following): Manage Permission Sets, Manage User Global Permissions
get/api/permission-sets

Query parameters

typePermissionSetType[]

Optional filter for the types of permission sets to retrieve

Response

Returns the list of permission sets

idstring required

The ID of the permission set.

type'Global' | 'Dataset' | 'CustomEntity' | 'ManualRedactionProject'

The type discriminator for Permission Sets which determines the kinds of operations available to that Permission Set.<p>Possible values:</p>

<ul> <li><b>Global</b>: Tonic-wide operations</li> <li><b>Dataset</b>: Dataset-specific operations</li> <li><b>CustomEntity</b>: Custom entity-specific operations</li> <li><b>ManualRedactionProject</b>: Manual redaction project operations</li> </ul>
namestring required

The name of the permission set.

isBuiltInboolean

Whether the permission set is built-in.

isDefaultboolean

Whether the permission set is the default permission set for its type.

isDisabledboolean

Whether the permission set is disabled.

lastModifiedDateInstant

A point in time represented as an ISO 8601 timestamp string.

operationsinteger[] nullable

The operations of the permission set. Only included for users with Manage Permission Sets permission.

createdDateInstant

A point in time represented as an ISO 8601 timestamp string.

lastModifiedByUserIdstring nullable

The ID of the user who last modified the permission set. Only included for users with Manage Permission Sets permission.

Changes