Package com.thingworx.security.applicationkeys

Class ApplicationKey

    • Constructor Detail

      • ApplicationKey

        public ApplicationKey()

    • Method Detail

      • SetClientName

        @ThingworxExtensionApiMethod(since={6,6})
public void SetClientName​(java.lang.String name)
                   throws java.lang.Exception
        Service Category:
        ApplicationKeys
        Service Description:
        Set the client name for this application key.
        Parameters:
        name - Client name - STRING
        Throws:
        java.lang.Exception - If an error occurs

      • GetKeyID

        @ThingworxExtensionApiMethod(since={6,6})
public java.lang.String GetKeyID()
                          throws java.lang.Exception
        Service Category:
        ApplicationKeys
        Service Description:
        Access the key ID.
        Returns:
        KeyID Key ID - STRING
        Throws:
        java.lang.Exception - If an error occurs

      • GetUserName

        @ThingworxExtensionApiMethod(since={6,6})
public java.lang.String GetUserName()
                             throws java.lang.Exception
        Service Category:
        ApplicationKeys
        Service Description:
        Get the associated user name.
        Returns:
        UserName Key ID - STRING
        Throws:
        java.lang.Exception - If an error occurs

      • SetUserName

        @ThingworxExtensionApiMethod(since={6,6})
public void SetUserName​(java.lang.String name)
                 throws java.lang.Exception
        Service Category:
        ApplicationKeys
        Service Description:
        Set the associated user name for this application key.
        Parameters:
        name - User name - USERNAME
        Throws:
        java.lang.Exception - If an error occurs

      • SetIPWhitelist

        @ThingworxExtensionApiMethod(since={6,6})
public void SetIPWhitelist​(java.lang.String list)
                    throws java.lang.Exception
        Service Category:
        ApplicationKeys
        Service Description:
        Set the IP whitelist for this application key.
        Parameters:
        list - IP whitelist (IP addresses - STRING
        Throws:
        java.lang.Exception - If an error occurs

      • SetExpirationDate

        @ThingworxExtensionApiMethod(since={6,6})
public void SetExpirationDate​(org.joda.time.DateTime expirationDate)
                       throws java.lang.Exception
        Service Category:
        ApplicationKeys
        Service Description:
        Set the expiration date.
        Parameters:
        expirationDate - The expiration date of the application key - DATETIME
        Throws:
        java.lang.Exception - If an error occurs

      • ResetExpirationDateToDefault

        @ThingworxExtensionApiMethod(since={6,6})
public void ResetExpirationDateToDefault()
                                  throws java.lang.Exception
        Service Category:
        ApplicationKeys
        Service Description:
        Resets the expiration date to the default set in the UserManagementSubsystem configuration.
        Throws:
        java.lang.Exception - If an error occurs

      • GetExpirationDate

        @ThingworxExtensionApiMethod(since={6,6})
public org.joda.time.DateTime GetExpirationDate()
        Service Category:
        ApplicationKeys
        Service Description:
        Get the expiration date.
        Returns:
        ExpirationDate The expiration date of the application key - DATETIME

      • IsExpired

        @ThingworxExtensionApiMethod(since={6,6})
public boolean IsExpired()
        Service Category:
        ApplicationKeys
        Service Description:
        Returns if the application key is expired.
        Returns:
        expired true if the application key is expired - BOOLEAN