Ownership, Orgs & Subscriptions

What's an Organization?

Organizations in Qrvey are a tagging system that enables you to group assets (such as dashboards) with users (as defined by clientId). This enables ownership of dashboards, as well as subscriptions within the Download Manager.

Ownership

Dashboards (excluding Legacy Dashboards) have the concept of ownership. When a user creates a dashboard, you must pass a clientId to identify the user and an orgId to identify the organization the user belongs to. If these values are not provided, they will be assumed as “anonymous,” unless there is a matching clientId in the orgs object from which the orgId can be retrieved.

All dashboards are available to all users within an application, regardless of the orgId in which they were created.

• Dashboard owners and users with the default Super Admin (used to be called Administrators) role in Composer are the only ones able to delete a dashboard.
• In embedded scenarios, if orgId: "org:0", any user with the Super Admin (used to be called Administrators) role and whose clientId matches their userId, or the clientId matches a userId with the Super Admin role, should also be able to delete a dashboard.
• The same behavior applies to API calls where a userId with the Super Admin role is provided, and the clientId equals that userId.
• If a user does not have access to a given application, they will not gain access to that application or its dashboards, regardless of their role or orgId.

Subscriptions

Subscribing other users to scheduled exports must occur within the same organization. The following are required:

• orgId
• orgs.users[] list of users with clientId and valid email. The orgs object should define the list of users available in the Subscriptions modal, so they can be added as recipients to a scheduled export. This list should be defined for each organization.

Note: You can also add external email addresses as recipients, even if they are not part of the users list for the organization.

Example:

"orgs": [
  {
    "orgId": "myOrg",
    "users": [
      {
        "clientId": "john_smith",
        "email": "john_smith@qrvey.com"
      }
    ]
  }
]

For JWT/configuration-based subscribing in embedded dashboards, embed the dashboard with the orgs[] object in the QV Token or configuration object. This enables the UI to display the list of users for subscriptions.

{
  "appId": "XVDq3Xr",
  "userId": "Sk7HuNH",
  "clientId": "jane_doe",
  "email": "jane_doe@qrvey.com"
  "expiresIn": "1y",
  "orgId": "myOrg",
  "orgs": [
    {
      "orgId": "myOrg",
      "users": [
        {
          "clientId": "john_smith",
          "email": "john_smith@qrvey.com"
        }
      ]
    }
  ]
}

When subscribing Composer users:

• Set orgId: "org:0" to associate it with the "Qrvey Composer" organization. Note: If you pass "org:0" into a widget, it will behave as if it is in Composer mode.
• The Subscribe option will list all Composer users and roles, and also allow the entire "Qrvey Composer" organization to be subscribed.

Note: Only a list of users will be displayed at a time, depending on the organization passed in orgId. Passing org:0 inside the orgs object has no effect; Composer users will always be displayed.