Skip to main content

User Permissions

Support
  • Updated

User types and API Keys are associated with a set of permissions, each one enabling a feature or read/write capability on a specific object.

The following is a list of permits grouped according to the topic they are intended for.

 

Alert

PERMISSION DESCRIPTION
WRITE_ALERT_STATUS Allows the user to acknoledge an alert.
READ_ALERT_TROUBLESHOOTING_HISTORY Allows the user to read the alert troubleshooting history.
CLEAR_ALERT Allows the user to clear manually an alert.

Consumable

PERMISSION DESCRIPTION
WRITE_CONSUMABLE_STOCK Allows the customer user to manage the stock.

Customer

PERMISSION DESCRIPTION
READ_CUSTOMER Allows the user to read the customers' information.
WRITE_CUSTOMER Allows the user to create, manage and delete customers (ORGANIZATION, PARTNER), write customer's information (CUSTOMER).
CUSTOMER_ACCOUNT_ADMINISTRATOR Allows the user to manage the customer account.
Applicable only to the user types of: CUSTOMER.
READ_ALL_CUSTOMERS Allows the user to read all customers registered within the tenant.
Available only in API Key permissions.
IMPORT_CUSTOMERS Allows administrative users to import customer data in a bulk way.
Applicable only to the user types of: ORGANIZATION, PARTNER.
READ_CUSTOMER_PROPERTY Allows the user to read the value of customer's properties.
[DEPRECATED] Replaced with write permission by user type in property definition.
WRITE_CUSTOMER_PROPERTY Allows the user to set the value of the customer's properties.
[DEPRECATED] Replaced with write permission by user type in property definition.
READ_CUSTOMER_PROPERTY_DEFINITION Allows the user to read and use the definition of the customer's properties.
[DEPRECATED] Configuration moved to the Servitly Console.

Location

PERMISSION DESCRIPTION
READ_LOCATION Allows the user to read the location's information.
WRITE_LOCATION Allows the user to create, manage and delete locations (ORGANIZATION, PARTNER), write location's information (CUSTOMER).
IMPORT_LOCATIONS Allows administrative users to import locations data in a bulk way.
READ_LOCATION_PROPERTY Allows the user to read the value of location's properties.
[DEPRECATED] Replaced with write permission by user type in property definition.
WRITE_LOCATION_PROPERTY Allows the user to set the value of the location's properties.
[DEPRECATED] Replaced with write permission by user type in property definition.
READ_LOCATION_PROPERTY_DEFINITION Allows the user to read and use the definition of the location's properties.
[DEPRECATED] Configuration moved to the Servitly Console.

Maintenance

PERMISSION DESCRIPTION
READ_MAINTENANCE_REGISTRY Allows the user to read the maintenance registry.
WRITE_MAINTENANCE_REGISTRY Allows the user to write the maintenance registry.

Notifications

PERMISSION DESCRIPTION
RECEIVE_THING_ALERT_NOTIFICATIONS Allows the user to receive alert notifications.
RECEIVE_THING_WORK_SESSION_NOTIFICATIONS Allows the user to receive work session notifications.

Organization

PERMISSION DESCRIPTION
READ_ORGANIZATION Allows the user to read the organization's information.
Applicable only to the user types of: ORGANIZATION.
WRITE_ORGANIZATION Allows the user to create, manage and delete organizations.
Applicable only to the user types of: ORGANIZATION.
READ_ALL_ORGANIZATIONS Allows the user to read all organizations registered within the tenant.
Available only in API Key permissions.
READ_ORGANIZATION_AUTHORIZATION Allows the user to read organizations' authorizations.
Applicable only to the user types of: ORGANIZATION.
WRITE_ORGANIZATION_AUTHORIZATION Allows the user to manage organization' authorizations.
Applicable only to the user types of: ORGANIZATION.

Partner

PERMISSION DESCRIPTION
READ_PARTNER Allows the user to read the partners' information.
WRITE_PARTNER Allows the user to create, manage and delete partners.
READ_PARTNER_AUTHORIZATION Allows the user to read partners' authorizations.
WRITE_PARTNER_AUTHORIZATION Allows the user to manage partners' authorizations.
Applicable only to the user types of: ORGANIZATION, PARTNER.
RECEIVE_PARTNER_AUTHORIZATION_UPDATE_NOTIFICATION Allows the user to receive a notification on partner authorizations updates.
READ_PARTNER_PROPERTY Allows the user to read the value of partner's properties.
[DEPRECATED] Replaced with write permission by user type in property definition.
WRITE_PARTNER_PROPERTY Allows the user to set the value of the partner's properties.
[DEPRECATED] Replaced with write permission by user type in property definition.
READ_PARTNER_PROPERTY_DEFINITION Allows the user to read and use the definition of the partner's properties.
[DEPRECATED] Configuration moved to the Servitly Console.

Payments

PERMISSION DESCRIPTION
READ_PAYMENTS Allows the user to read all payments done by customers.
Applicable only to the user types of: ORGANIZATION.
WRITE_PAYMENTS Allows the user to edit and approve payments.
Applicable only to the user types of: ORGANIZATION.

Security

PERMISSION DESCRIPTION
READ_API_KEY Allows the user to read the API Key configured on partner or customer entities.
WRITE_API_KEY Allows the user to write, manage and delete API Keys for partners and customers.
Applicable only to the user types of: ORGANIZATION.
READ_AUDIT Allows the user to read user events.

Service

PERMISSION DESCRIPTION
READ_SERVICE Allows the user to read the service definition.
WRITE_SERVICE Allows the user to configure the service definition.
[DEPRECATED]
READ_SERVICE_SUBSCRIPTION Allows the user to read the status of the service subscription.
WRITE_SERVICE_SUBSCRIPTION Allows the customer user to manage the service level modification.

Subscription

PERMISSION DESCRIPTION
READ_SUBSCRIPTION Allows the user to read subscription information.
WRITE_SUBSCRIPTION Allows the user to configure the subscription information.

Testing

PERMISSION DESCRIPTION
READ_THING_TEST Allows the user to read thing test sessions.
WRITE_THING_TEST Allows the user to manage thing test sessions.
READ_CONNECTION_TEST Allows the user to read the connection tests.
Applicable only to the user types of: ORGANIZATION, PARTNER.
WRITE_CONNECTION_TEST Allows the user to start connection tests.
Applicable only to the user types of: ORGANIZATION, PARTNER.

Thing

PERMISSION DESCRIPTION
READ_THING_DEFINITION Allows the user to read the thing definition catalog.
[DEPRECATED] Configuration moved to the Servitly Console.
READ_THING Allows the user to read the things' information.
WRITE_THING Allows the user to create, manage and delete things.
WRITE_THING_OPTION Allows the user to set Thing's options.
READ_RULE Allows the user to read the thing's defined rules.
WRITE_RULE Allows the user to write, manage and delete thing's defined rules.
EXECUTE_THING_COMMAND Allows the user to execute commands on the connected things.
SET_THING_PARAMETER Allows the user to set configuration parameters to the connected things.
WRITE_DATA Allows the user to call the API for data import.
REGISTER_THING Allows the user to register new things without an owner.
WRITE_THING_ACTIVATION Allows the user to activate a new thing.
READ_CLOUD_STATUS Allows the service manager to read the thing cloud status.
WRITE_CLOUD_STATUS Allows the service manager to change the thing cloud status.
Applicable only to the user types of: ORGANIZATION, PARTNER.
READ_CERTIFICATE Allows the administrator to read the thing certificates.
Applicable only to the user types of: ORGANIZATION, PARTNER.
WRITE_CERTIFICATE Allows the administrator the management of the thing certificates.
Applicable only to the user types of: ORGANIZATION, PARTNER.
UPDATE_FIRMWARE Allows the technichian to trigger firmware upates.
WRITE_RECIPE Allows the administration of the recipe catalog.
READ_ALL_THINGS Allows the user to read all things of the tenant.
Available only in API Key permissions.
WRITE_THING_TAG Allows the user to tag a thing.
EXECUTE_BULK_UPDATE Allows the user to perform a bulk update.
WRITE_METRIC_VALUE Allows the user to set a metric value.
WRITE_SIM Allows the user to verify and change the status of the SIM installed within the product.
Applicable only to the user types of: ORGANIZATION.
READ_USER_AUTHORIZATION Allows the user to read the user authorizations on customer's Things.
Applicable only to the user types of: CUSTOMER.
WRITE_USER_AUTHORIZATION Allows the user to read the user authorizations on customer's Things.
Applicable only to the user types of: CUSTOMER.
RESET_USER_AUTHORIZATION Allows the user to reset the user to thing authorizations.
Applicable only to the user types of: CUSTOMER.
READ_THING_PROPERTY Allows the user to read the value of thing's properties.
[DEPRECATED] Replaced with write permission by user type in property definition.
WRITE_THING_PROPERTY Allows the user to set the value of the thing's properties.
[DEPRECATED] Replaced with write permission by user type in property definition.
READ_THING_DEFINITION_PROPERTY Allows the user to read the value of thing definition's properties.
[DEPRECATED] Configuration moved to the Servitly Console.
READ_THING_PROPERTY_DEFINITION Allows the user to read and use the definition of the thing's properties.
[DEPRECATED] Configuration moved to the Servitly Console.
READ_THING_DEFINITION_PROPERTY_DEFINITION Allows the user to read and use the definition of the thing definition's properties.
[DEPRECATED] Configuration moved to the Servitly Console.

Thing Connection

PERMISSION DESCRIPTION
READ_CONNECTION_MAPPING Allows the user to read connection mappings.
WRITE_CONNECTION_MAPPING Allows the user to configure connection mappings.
READ_THING_CONNECTION_TOKENS Allows the user to read the registered connection tokens.
Applicable only to the user types of: ORGANIZATION, PARTNER.
WRITE_THING_CONNECTION_TOKENS Allows the user to register new connection tokens.
Applicable only to the user types of: ORGANIZATION, PARTNER.

User

PERMISSION DESCRIPTION
READ_USER Allows the user to read the users' information.
WRITE_USER Allows the user to create, manage and delete users.
READ_USER_PERMISSIONS Allows the user to read other users' permissions.
WRITE_USER_PERMISSIONS Allows the user to manage users' permissions.
NEVER_SUSPEND Allows the user to never expire even if inactive for a long time.
WRITE_USER_STATUS Allows the administrator to update the user status.
READ_GUEST_USER Allows the user to read the invited guest users.
INVITE_GUEST_USER Allows the user to invite new users.
WRITE_USER_NOTIFICATION_SETTINGS Allows the user to edit notification preference of another user.
Applicable only to the user types of: ORGANIZATION, PARTNER.
READ_ALL_USERS Allows the user to read all users registered within the tenant.
Available only in API Key permissions.
READ_USER_PROPERTY Allows the user to read the value of user's properties.
[DEPRECATED] Replaced with write permission by user type in property definition.
WRITE_USER_PROPERTY Allows the user to set the value of the user's properties.
[DEPRECATED] Replaced with write permission by user type in property definition.
READ_USER_PROPERTY_DEFINITION Allows the user to read and use the definition of the user's properties.
[DEPRECATED] Configuration moved to the Servitly Console.

Servitly Billing

PERMISSION DESCRIPTION
READ_SEMIOTY_SUBSCRIPTION Allows the user to read the Servitly billing.
[DEPRECATED] Billing page moved to the Servitly Console.

Related articles

Comments

0 comments

Please sign in to leave a comment.