Document Roles

Documents and binders can have different roles available to them depending on their type and lifecycles. There are a set of standard roles that ship with Vault: owner__v, viewer__v, and editor__v. In addition, Admins can create custom roles defined per lifecycle. Learn more about Roles in Vault Help.

Through the Role APIs, you can:

• Retrieve available roles on documents and binders
• Determine who can be assigned to roles
• Retrieve default users who are assigned automatically within the Vault UI
• Retrieve who is currently assigned to a role
• Add additional users and groups to a role
• Remove users and groups from roles

Note that all user and group information is returned as IDs and you need to use the Retrieve User or Retrieve Group API to determine the name, etc.

For roles on object records, see Object Roles.