Skip to content

Latest commit

 

History

History
18 lines (14 loc) · 5.57 KB

Permissions.md

File metadata and controls

18 lines (14 loc) · 5.57 KB

Permissions

Describes the permissions levels that a user has for permissioned features. When the client sends this, Permissions.read and Permissions.write are the additional permissions granted to a user on top of what they have via their roles. When the server sends this, Permissions.read and Permissions.write are the complete (merged) set of permissions the user has, and Permissions.roles is just for display purposes.

Fields

Field Type Required Description
canAdminSearch Optional<Boolean> ➖ TODO--deprecate in favor of the read and write properties. True if the user has access to /adminsearch
canAdminClientApiGlobalTokens Optional<Boolean> ➖ TODO--deprecate in favor of the read and write properties. True if the user can administrate client API tokens with global scope
canDlp Optional<Boolean> ➖ TODO--deprecate in favor of the read and write properties. True if the user has access to data loss prevention (DLP) features
read Map<String, List\<ReadPermission>> ➖ Describes the read permission levels that a user has for permissioned features. Key must be PermissionedFeatureOrObject
write Map<String, List\<WritePermission>> ➖ Describes the write permissions levels that a user has for permissioned features. Key must be PermissionedFeatureOrObject
grant Map<String, List\<GrantPermission>> ➖ Describes the grant permission levels that a user has for permissioned features. Key must be PermissionedFeatureOrObject
role Optional<String> ➖ The roleId of the canonical role a user has. The displayName is equal to the roleId.
roles List<String> ➖ The roleIds of the roles a user has.