How to > Create an Application Key for an Edge Device
Create an Application Key for an Edge Device
When connecting to a ThingWorx Platform, the edge device application needs to present an application key for authentication. This application key needs to be associated with a non-admin user. The sections below explain how to create the non-admin user for an edge device (Thing) and how to configure the application key.
To be able to create a non-admin user or an application key, you must log in as an Administrator of ThingWorx Platform or as a member of a user group that has permissions and visibility to these security entities.
Creating a Non-Admin User in ThingWorx Composer
Follow these steps to create a non-admin user for the application key:
1. Log in to ThingWorx Composer.
2. In the left navigation panel, select Browse and scroll down to Security.
3. Select Users to display the list of users currently configured in the platform.
4. In the bar just above the list, click +New.
5. In the General Information page, type a name for the edge device user account. For example, edgeUser. You will associate this user with an application key for the edge device, so do not enter a password.
6. If desired, enter a Description for this user.
7. Check to make sure that the Enabled check box is selected, and click Save.
Follow these steps to configure an application key and a Thing to represent the edge SDK device in ThingWorx Composer:
1. From Security > Application Keys > , click > +New.
2. Enter the appropriate values:
a. Name — A name for the application key. For example, edgeDeviceAppKey23
b. User Name Reference — The name of a user account to associate with the application key. You can select from a list by clicking the plus icon in this field. A list from which you can select a user for the key appears:
In the example above, the edgeUser is selected. The permissions and visibility assigned to this user account affect what the edge device application can do on the platform. For example, write new values to remote properties.
c. Expiration Date — A date in the future for the application key to expire, based on your company policies. The default value is one day. Use the calendar widget to select a date and the time widget to select a time.
3. Click Save.
4. Create a Thing in ThingWorx for the asset that is running the edge application. Depending on the features you want to use, choose one of the following Thing Templates or a Thing Template that implements any of the following Thing Templates:
RemoteThingWithTunnelsAndFileTransfer — Use for assets for which you want file transfers, SCM, and remote access capabilities.
RemoteThingWithFileTransfer — Use for assets for which you want file transfers (upload and download) and/or SCM capabilities, but not remote access capabilities.
RemoteThingWithTunnels — Use for assets for which you want to use remote access capabilities but not file transfers or SCM.
The Software Content Management capabilities are not available for all Edge SDKs.
5. Once you have an application key, follow the instructions for setting up your edge application to present an application key when connecting to a ThingWorx Platform.
Was this helpful?