Contains API calls related to sub-users, that is, additional users who have access to your account and monitoring assets. Sub-users is convenient way for corporate clients to provide multiple employees, who have different roles and priveleges, with access to the monitoring system.

“Usual” user account is called “master account” in relation to sub-users.

Every sub-user can operate on a subset of trackers from your “master account”. Every entity, which is associated with unavailable trackers, also becomes hidden from sub-user. This is called “scoping”.
Sub-users’s rights can also be limited to prevent unauthorized changes to your data and application setting.

NOTE: Sub-users cannot have any “exclusive” objects. Every tracker, rule, task, etc., even created or edited by sub-user, still belongs to your account.
The only exception is reporting system: every sub-user has its own reports pool and reports schedule.

Sub-user object structure

Sub-user object is almost identical to usual user.

<subuser> = {
      "id": 103, //sunuser id, can be null (when creating new sub-user)
      "activated": true,                // true if user is activated (allowed to login)
      "login": "[email protected]",         // User email as login. Must be valid unique email address
      "first_name": ${string},          // User's or contact person first name
      "middle_name": ${string},         // User's or contact person middle name
      "last_name": ${string},           // User's or contact person last name
      "legal_type": "legal_entity",     // either "legal_entity", "individual" or "sole_trader"
      "phone": "491761234567",          // User's or contact phone (10-15 digits)
      "post_country": "Germany",        // country part of user's post address
      "post_index": "61169",            // index part of user's post address
      "post_region": "Hessen",          // region part of user's post address
      "post_city": "Wiesbaden",         // city from postal address
      "post_street_address": "Marienplatz 2", // street address
      "registered_country": "Germany",  // country part of user's registered address
      "registered_index": "61169",      // index part of user's registered address
      "registered_region": "Hessen",    // region part of user's registered address
      "registered_city": "Wiesbaden",   // city from registered address
      "registered_street_address": "Marienplatz 2", // User's registered address
      "state_reg_num": ${string},       // State registration number. E.g. EIN in USA, OGRN in Russia. 15 characters max.
      "tin": ${string},                 // Taxpayer identification number aka "VATIN"
      "legal_name": "E. Biasi GmbH",    // user legal name (for "legal_entity" only)
      "iec": ${string},                 // Industrial Enterprises Classifier aka "KPP" (used in Russia. for "legal_entity" only)
      "security_group_id": 333,         // Id of the security group to whic sub-user belongs to. Can be null, which means default group with no privileges          
      //this fields are read-only, they should not be used in user/update(..)
      "creation_date": "2016-05-20 00:00:00" // date/time when user was created

If you have more questions please contact our support team


USA: +1 858 225 46 88

Mexico: +52 558 526 11 25

UK: +44 203 807 64 62

Russia: +7 495 128 35 56

We use сookies to improve our website, products and related services, analyze site traffic, and serve targeted advertisements. If you continue to use our services, you consent to our use of сookies. Read more

Log in