Each Client Account can have multiple permissioned users on the account. These sub-users are called contacts. Contacts are uniquely identified by their email and client account.

Adding Contacts

Additional team members can be added as contacts in your control panel by clicking the gravatar in the upper right corner and selecting account users.

When created from the portal, the contact will receive an email prompting them to set their password. After their password is set, they can access the client account.

You can also create a contact by making a POST request to /contact.

curl -X 'POST' \
  'https://core.hivelocity.net/api/v2/contact/' \
  -H 'accept: application/json' \
  -H "X-API-KEY: $API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
      "description": "IT Manager",
      "phone": "81355555555",
      "email": "[email protected]",
      "fullName": "John Snow",
      "password": "SecurePassword",
      "active": 1
}'

Sharing Contacts across Client Accounts

If you manage multiple client accounts, you may create contacts with the same email address across those client accounts. When you authenticate to the myVelocity portal, you will be prompted to select which contact's portal you would like to manage:

📘

Controlled Client Accounts can also share emails

Normally, client accounts cannot share emails. If you are a multi account reseller then you can give your controlled client accounts the same email address as your primary account.

Permissions

Granular permissions can be modified for each individual contact. New contacts have no permissions by default. The permissions granted apply to both portal and API access. You can update a contact's permissions by navigating to account users and clicking edit contact on the contact you wish to modify.

You can also modify contact permissions with a POST request to the /permission/contact endpoint. The permissions fields must be filled with the keys returned from a GET request to /permission.

Via the API

Getting available permissions from the API

curl -X 'GET' \
  'https://core.hivelocity.net/api/v2/permission/' \
  -H 'accept: application/json' \
  -H "X-API-KEY: $API_KEY"

Getting a user's permissions from the API

curl -X 'GET' \
  'https://core.hivelocity.net/api/v2/permission/contact/$CONTACT_ID' \
  -H 'accept: application/json' \
  -H "X-API-KEY: $API_KEY"

Adding Permissions via the API

curl -X 'POST' \
  'https://core.hivelocity.net/api/v2/permission/contact' \
  -H 'accept: application/json' \
  -H "X-API-KEY: $API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "userId": $CONTACT_ID,
  "permissions": [
    "devices.deploy"
  ]
}'

For more info on managing permissions programmatically, see the Permission API Reference.

Locking Permissions

A contact's permissions can be locked and unlocked by the client account. Once locked, no other contact can modify the locked contact's permissions. If a contact has permission to update other contact's permissions, it is recommended the client account lock the contact with the permissions to grant.

To lock a contact's permission, navigate to account users, click edit contact on the contact you wish to lock, then check the box with a lock icon next to permissions.

Permission Groups

For contacts that require identical permissions, permission groups can be created once with the required permissions. Then the group can be assigned to the appropriate contacts.

To create a permissions group, navigate to account users and click Manage Permissions Groups.