MarkLogic 12 Product Documentation

Role Configuration Help

---

A Role gives privileges and permissions to a user.

• role name is the name of the role.
• description is an optional field to describe the user.
• A compartment is an optional field that places the role into the named compartment. If a document has any permissions (role/capability pairs) with roles that have a compartment, then the user must have those roles with each of the compartments (regardless of which permission they are in) to perform any of the capabilites.
• default external names TBD.
• A user or another role can have multiple roles. Roles assigned to a user (or role) give privileges and permissions to the user (or role). Check any roles to associate them with this configuration.
• URI privileges specifies the URI privileges associated with the role.
• execute privileges specifies the execute privileges associated with the role.
• A permission is a pairing of a role with a capability (read, insert, update, execute). default permissions are optional fields that specify the default document permissions associated with the user. If the user does not explicitly specify permissions during document creation, the document will have the user's default permissions
• default collections are optional fields that specify the default document collections associated with the user. If the user does not explicitly specify collections during document creation, the document will have the user's default collections. A document can belong any number of collections.

---

Buttons and Tabs:

• The Summary tab displays a list of all of the currently configured users, including the roles assigned to each user.
• The Configure tab allows you to edit existing users.
• The Create tab allows you to create new users.