ThingWorx Model Definition in Composer > Security > Application Keys > Application Key Services
Application Key Services
There are several services that can be useful when working with application keys.
Application Key Services
Service Name
Description
GetExpirationDate
Returns the expiration date of the application key.
GetKeyID
Returns the keyID for an application key.
GetUserName
Returns the associated user name for an application key.
IsExpired
Returns true if the application key is expired.
ResetExpirationDatetoDefault
Sets the expiration date to the default in the User Management Subsystem configuration.
SetClientName
Sets the client name for an application key.
SetExpirationDate
Set the expiration date for an application key. Accepts a DATETIME base type and persists the value immediately.
SetIPWhitelist
Sets the IP whitelist for an application key.
SetUserName
Sets the associated user name for an application key.
User Services
Service Name
Description
DeleteApplicationKeys
Deletes application keys associated with a specified user. To delete any application keys, specify true as a value for at least one parameter (expiredKeys or unexpiredKeys). To delete any application keys, specify true as a value to both parameters.
DoesApplicationKeyWithKeyIdExist
Returns true if the specified key id associated with the user exists.
GetApplicationKeyExpirationInfo
• Gets application key expiration info associated with a user. Specify true to at least one parameter (expiredKeys or unexpiredKeys) to return any application keys; true to both parameters to return all application keys.
• Returns a data shape of ApplicationKeyExpirationInfo.
User Management Subsystem
Service Name
Description
DeleteApplicationKeys
Deletes application keys associated with the specified user. Specify true to at least one parameter to delete any application keys, or true to both parameters to delete all application keys.
DoesApplicationKeyWithKeyIdExist
Returns true if the specified key id associated with the user exists.
GetApplicationKeyExpirationInfo
Gets application key information associated with the user specified. You must specify true to at least one parameter (expiredKeys or unexpiredKeys) to return any application keys; true to both parameters to return all application keys.
Entity Services
Service Name
Description
CreateApplicationKey
Creates a new application key.
DeleteApplicationKey
Deletes an application key.
Related Links
Application Keys
Was this helpful?