Object: global_permissions

Usage & Structure

Defines permissions associated with the app. Any permissions created by your app will appear in the account-level permissions tree in the Uberflip application (under Account Settings > Organization > Groups > Account Administrators > Permissions). They can be manually assigned to any user or User Group just like a normal permission.

Consists of one or more global_permission objects that each contain the properties listed below.

Properties

• code string / required: The unique identifier used to reference the permission.
  • Create a new permission by prefacing value with an underscore ("_").
  • Can also be the code of an existing system default permission. See here for a list of system default permissions and their codes.
• name string / required / max: 100: The display name of the permission which will be shown in the Uberflip application.
• description string / required / max: 200: A brief description of what the permission grants access to.
• license_code: string / optional: The license which must be enabled for the permission to be visible.
  • Value must match value of licenses.license.code.
  • Each permission may be associated with only one license.
  • Can also be the code of an existing system default license. See here for a list of system default licenses and their codes.
• children array / optional: The child permission(s) to be added one hierarchical level below the parent permission.
  • Value must be one or more global_permission objects (containing all of the required properties listed above).
  • Each object in the array may itself contain a children property, so you can create any number of levels in the hierarchy.
  • May not be used if the value of the code property in the parent permission is an existing system default permission (i.e. can't create new child permissions under system default parent permissions).

Sample Manifest

"global_permissions" : [
    {
      "code": "_EXAMPLE_APP_PARENT_PERMISSION",
      "name": "Example App Permissions",
      "description": "All Permissions for Example App",
      "license_code": "_EXAMPLE_LICENSE_CODE",
      "children" : [
        {
          "code": "_EXAMPLE_APP_READ_CONFIG",
          "name": "Read Configuration", 
          "description": "Grants permission to view configuration fields for Example App."
        },
        {
          "code": "_EXAMPLE_APP_WRITE_CONFIG",
          "name": "Edit Configuration", 
          "description": "Grants permission to edit configuration fields for Example App."
        }
      ]
    }
  ]

Referencing

Any permissions you define with this object can also be referenced in the following objects:

• user_groups
• users
• config_fields
• hub_sidenav_items