OAUTH 2.0 Scopes for SmartWorks IoT APIs

This documents lists the OAuth 2.0 scopes available to access to SmartWorks IoT APIs. Choose what scopes you should request for based on the level of access you need over the resources you are requesting. Note that you can only request those scopes you have been granted.


Table 1.
Scope Definition
data Any operation on Data
data.create Send streams of Data
data.read Retrieve the stored streams of Data
data.delete Delete the stored streams of Data


Table 2.
Scope Description
thing Any operation on Things
thing.create Create new Things, Actions and Trigger Events
thing.read Retrieve Things, Properties, Actions and Events
thing.update Update Things, Properties and Actions
thing.delete Delete Things and Actions


Table 3.
Scope Description
collection Any operation on Collections
collection.create Add new Collections
collection.read Retrieve Collection information
collection.update Update Collection information
collection.delete Delete a Collection

Models and Versions

Table 4.
Scope Description
model Any operation on Models and Versions
model.create Add new Models and Versions
model.read Retrieve Model and Version information
model.update Update a Model or create a new Version
model.delete Delete a Model


Table 5.
Scope Definition
mqtt Any operation on MQTT
mqtt.credentials.read Retrieve the MQTT credentials
mqtt.credentials.update Update the MQTT credentials


Table 6.
Scope Descriptions
cluster Any operation on Clusters
cluster.create Create new Clusters
cluster.read Retrieve Clusters
cluster.update Update Clusters
cluster.delete Delete Clusters
cluster.reinstall Request for Clusters reinstallation

Cluster Resources

Table 7.
Scope Descriptions
resource Any operation on Cluster Resources
resource.create Add new Cluster Resources.
resource.read Retrieve Cluster Resources
resource.update Update a Cluster Resource
resource.delete Delete a Cluster Resource

Edge Applications

Table 8.
Scope Descriptions
edge-app Any operation on Edge Applications
edge-app.create Add new Edge Applications
edge-app.read Retrieve Edge Application information
edge-app.update Update an Edge Application
edge-app.delete Delete an Edge Application

Cluster Resources

Table 9.
Scope Descriptions
resource Any operation on Cluster Resources
resource.create Add new Cluster Resources
resource.read Retrieve Cluster Resources
resource.update Update a Cluster Resource
resource.delete Delete a Cluster Resource


Table 10.
Scope Description
label Any operation of Labels
label.create Add new Labels
label.read Retrieve Label information
label.update Update a Label
label.delete Delete a Label


Table 11.
Scope Description
policy Any operation on Policies.
policy.create Add new permissions of users and roles over resources
policy.read Retrieve user and role permissions
policy.update Update user and role permissions
policy.delete Delete user and role permissions


Table 12.
Scope Description
role Any operation on Role associations
role.create Add new user-role and role-role associations
role.read Retrieve Role associations
role.update Update Role associations
role.delete Delete Role associations


Table 13.
Scope Description
app Any operation on Apps
app.create Add new App
app.read Retrieve App information
app.update Update an App
app.delete Delete an App


Table 14.
Scope Description
function Any operation on Functions
function.create Add new Functions
function.read Retrieve Function information
function.update Update a Function
function.delete Delete a Function
function.invoke Invoke a Function
function.log Retrieve Function log
function.code Retrieve Function code


Table 15.
Scope Description
trigger Any operation on Triggers
trigger.create Add new Triggers
trigger.read Retrieve Trigger information
trigger.update Update a Trigger
trigger Delete a Trigger


Table 16.
Scope Description
email Any operation on Email utils
email.send Send Emails

Limits Usage

Table 17.
Scope Description
usage Any operation on Limits Usage
usage.read Retrieve Limits Usage information


Table 18.
Scope Description
user Any operation on Users
user.read Retrieve User information
user.delete Delete a User from a Space


Table 19.
Scope Description
invitation Any operation on Invitations
invitation.create Add new Invitations
invitation.read Retrieve Invitation information
invitation.update Update an Invitation
invitation.delete Delete an Invitation

Spaces (can only be used by Studio)

Table 20.
Scope Description
space Any operation on Spaces
space.create Add new Spaces
space.read Retrieve Space information
space.update Update Space information
space.delete Delete a Space