Classes Used
The sections below summarize the classes that are used to develop the Edge device authenticator, and the classes that are used to add security claims to the Edge device.
Edge Device Authentication Extension Classes
The following ThingWorx Platform API classes are used in the development of the Edge device authenticator extension:
• SecurityClaimsAuthenticator — Class that is used to implement the customized functionality included in an authenticator extension using the following methods:
 |
SecurityClaimsAuthenticator is not intended to handle HTTP requests and throws exceptions if they are used.
|
◦ matchesAuthRequest — Method that is used to determine whether the security claims provided by the Edge device should be processed by the authentication extension.
Returns true if there is a successful match, otherwise false.
◦ authenticate — Method used to determine how to validate the security claims provided by the edge device for authentication with the ThingWorx Platform.
Returns a valid ThingWorx user id that is used to define the permissions available to an authenticated connection.
• SecurityClaims — Class that is used to manage the security settings for connections to the ThingWorx platform. This class acts as a wrapper around the map of key/value credentials supplied by the edge device. For the authenticator extension, SecurityClaims is used to pass the credentials to the SecurityClaimsAuthenticator methods.
• AuthenticatorException — Class that handles authentication exceptions.
Adding Edge Device Security Claims Classes
The following ThingWorx Platform API and ThingWorx Edge SDK classes are used in adding security claims to the edge device:
• APIClient — Class from the ThingWorx Edge SDK that is used to connect an edge device through an API server.
• ClientConfigurator — Class from the ThingWorx Edge SDK that is used by the edge device to control its behavior and connect to the ThingWorx Platform.
• SecurityClaims — Class from the ThingWorx platform API that is used to manage the security settings for connections to the ThingWorx platform. This class acts as a wrapper around the map of key/value credentials supplied by the edge device. For the Edge device, SecurityClaims is used to submit security credentials to the authenticator extension.