8.4.24 Fields: User's Permissions

See the associated 4.15  Permissions resource section for more information on how to use this resource and supported operations.

Additional References

Type Value Additional Information
Permissions resource permissions/users Permissions
Hooks filename permissions.users.groovy Pre- and Post-Processing Hooks
Distinct query-supported Yes Distinct

UserPermission

Field Name Type Description
id String

The unique ID of the cached user permission.
name String

The unique name of the user.
permissions List<Permission>

The list of permissions.

Permission

Represents a permission.

Field Name Type Description
id String

The unique ID of this role.
action String

The action that can be performed on the resource.
administrator Boolean

If true, grants full rights over the given resource for the given action. For example, if resource is 'jobs' and action is 'update' and administrator is true, then this permission allows the user to update any job, not just jobs owned by the user.
description String

A description of this permission.
fieldPath String

Field level ACL control, if null or '*', all fields are accessible; otherwise requests must match dot delimited path. Currently only checked when doing writable actions. For example, attributes.*: create|update
label String

A human readable label for this permission.
resource String

The resource the permission applies to.
resourceFilter Map<String, Map>

A map used to limit which resource instances this permission applies to. If this is null then the permission will apply to all instances of the resource. For api permissions the filter uses mongo query syntax.
type String

The type of the permission. Only 'api' type permissions are enforced.

Related Topics