Account Roles

The Account Roles enables you to create and manage the roles associated with your account. This functionality is available to Admins (or to any role that has the appropriate permissions). A Role consists of a set of permissions. Once a role created, it can be assigned to individual users, enabling them to access the ValidSign functionality they need.

Manage Account Roles

Introduction of Account Roles

The Account Roles enables you to create and manage the roles associated with your account. This functionality is available to Admins (or to any role that has the appropriate permissions). A Role consists of a set of permissions.

Available Permissions

The permissions that are available to set is listed below:

  • Sender admin
    • Event Notification
    • Custom Fields
    • Subscription account billing details
    • Reports
    • User Management
    • Roles
    • Security Settings
    • Customization
    • Notary
    • Api Access
    • Data Management
    • Sub Account Management
  • Groups
    • Group Signing Management
  • Templates & Layouts
    • Share Template
    • Share Layout
  • Transaction
    • Transaction
    • In Person Signing
    • Change Signer Option
    • Transaction visibility in delegation
  • Sender admin
    • sender_admin.event_notification
    • sender_admin.custom_fields
    • sender_admin.subscription
    • sender_admin.reports
    • sender_admin.users
    • sender_admin.role
    • sender_admin.security_settings
    • sender_admin.customization
    • sender_admin.notary
    • sender_admin.api_access
    • sender_admin.data_management
    • sender_admin.sub_account_management
  • Groups
    • groups.group_signing_management
  • Templates & Layouts
    • templates_layouts.share_templates
    • templates_layouts.share_layouts
  • Transaction
    • transaction.transaction
    • transaction.in_person
    • transaction.change_signer
    • transaction.delegation_visibility

 

GET /api/account/roles
Retrieves Account Roles

To retrieve a list with the account role information, such as name and permissions, for the current system account, you can use the following example requests.

GET /api/account/roles
Create new role

To create a new account role for your account, you can use the following example requests.

POST /api/account/roles

{
    "name": "Backoffice",
    "enabled": true,
    "description": "Able to create and prepare Transactions",
    "permissions": [
        "templates_layouts.share_templates",
        "templates_layouts.share_layouts",
        "transaction.transaction",
        "transaction.in_person",
        "transaction.change_signer"
    ]
}
Update an Account Role

To updates an account role, for example, to change permission settings, or role name, you can use the following example requests.

PUT /api/account/roles/{accountRoleId}

{
    "name": "Backoffice Role",
    "enabled": true,
    "description": "Able to create and prepare Transactions without Template access",
    "permissions": [
        "transaction.transaction",
        "transaction.in_person",
        "transaction.change_signer"
    ]
}
Retrieve specified Account Role

To retrieve a specific account role, you can use the following example requests.

GET /api/account/roles/{accountRoleId}