Skip navigation links
Thingworx Platform API
9.0.0
com.thingworx.system.subsystems.scim

Class SCIMSubsystem

    • Constructor Detail

      • SCIMSubsystem

        public SCIMSubsystem()
    • Method Detail

      • validateConfiguration

        @ThingworxExtensionApiMethod(since={7,3})
        public void validateConfiguration(ImportedEntityCollection importedEntityCollections)
                                                                             throws java.lang.Exception
        Description copied from class: RootEntity


        Validates the configuration of the entity during the import process. This method is called whenever a entity is created or modified via the REST APIs. During the validation step, there may be other associated entities that are being imported. These can be accessed via the importedEntities collection if needed.

        Note that some resources belonging to the entity or other associated entities may not be available during this step in the lifecycle.

        It is required for all subclasses of RootEntity to call super.validateConfiguration(importedEntityCollections) if they override this method.

        Overrides:
        validateConfiguration in class RootEntity
        Parameters:
        importedEntityCollections - - a typed collection of entities currently being imported
        Throws:
        java.lang.Exception - If an error occurs
      • GetProvisioningOptions

        @ThingworxExtensionApiMethod(since={8,0})
        public InfoTable GetProvisioningOptions()
                                                                                   throws java.lang.Exception
        Service Category:
        SSO
        Service Description:
        Returns Provisioning Options.
        Returns:
        result User Provisioning Options - INFOTABLE - Aspects {dataShape:SCIMProvisioningOptions}
        Throws:
        java.lang.Exception - If an error occurs
      • SetProvisioningOptions

        @ThingworxExtensionApiMethod(since={8,0})
        public void SetProvisioningOptions(InfoTable provisioningOptions)
                                                                              throws java.lang.Exception
        Service Category:
        SSO
        Service Description:
        Sets Provisioning Options.
        Parameters:
        provisioningOptions - - INFOTABLE
        Throws:
        java.lang.Exception - If an error occurs
      • GetUserProvisioningExclusionList

        @ThingworxExtensionApiMethod(since={8,0,0})
        public InfoTable GetUserProvisioningExclusionList()
                                                                                               throws java.lang.Exception
        Service Category:
        SCIM
        Service Description:
        Return the User Provisioning Exclusion List.
        Returns:
        result List of excluded users from provisioning - INFOTABLE - Aspects {dataShape:UserProvisioningExclusionList}
        Throws:
        java.lang.Exception - If an error occurs
      • SetUserProvisioningExclusionList

        @ThingworxExtensionApiMethod(since={8,0,0})
        public void SetUserProvisioningExclusionList(InfoTable users)
                                                                                          throws java.lang.Exception
        Service Category:
        SCIM
        Service Description:
        Set the User Provisioning Exclusion List.
        Parameters:
        users - The user provisioning user exclusion list to set - INFOTABLE
        Throws:
        java.lang.Exception - If an error occurs
      • GetUserProvisioningDefaults

        @ThingworxExtensionApiMethod(since={8,0,0})
        public InfoTable GetUserProvisioningDefaults()
                                                                                          throws java.lang.Exception
        Service Category:
        SCIM
        Service Description:
        Return the User Provisioning User Default Settings.
        Returns:
        result User Defaults - INFOTABLE - Aspects {dataShape:UserProvisioningDefaultSettings}
        Throws:
        java.lang.Exception - If an error occurs
      • SetUserProvisioningDefaults

        @ThingworxExtensionApiMethod(since={8,0,0})
        public void SetUserProvisioningDefaults(InfoTable userDefaults)
                                                                                     throws java.lang.Exception
        Service Category:
        SCIM
        Service Description:
        Set the User Provisioning Defaults.
        Parameters:
        userDefaults - The user provisioning user defaults - INFOTABLE
        Throws:
        java.lang.Exception - If an error occurs
      • GetGroupProvisioningExclusionList

        @ThingworxExtensionApiMethod(since={8,0,0})
        public InfoTable GetGroupProvisioningExclusionList()
                                                                                                throws java.lang.Exception
        Service Category:
        SCIM
        Service Description:
        Return the Group Provisioning Exclusion List.
        Returns:
        result List of excluded group from provisioning - INFOTABLE - Aspects {dataShape:GroupProvisioningExclusionList}
        Throws:
        java.lang.Exception - If an error occurs
      • SetGroupProvisioningExclusionList

        @ThingworxExtensionApiMethod(since={8,0,0})
        public void SetGroupProvisioningExclusionList(InfoTable groups)
                                                                                           throws java.lang.Exception
        Service Category:
        SCIM
        Service Description:
        Set the Group Provisioning Exclusion List.
        Parameters:
        groups - The group provisioning group exclusion list to set - INFOTABLE
        Throws:
        java.lang.Exception - If an error occurs
      • GetGroupProvisioningDefaults

        @ThingworxExtensionApiMethod(since={8,0,0})
        public InfoTable GetGroupProvisioningDefaults()
                                                                                           throws java.lang.Exception
        Service Category:
        SCIM
        Service Description:
        Return the Group Provisioning Group Default Settings.
        Returns:
        result Group Defaults - INFOTABLE - Aspects {dataShape:GroupProvisioningDefaultSettings}
        Throws:
        java.lang.Exception - If an error occurs
      • SetGroupProvisioningDefaults

        @ThingworxExtensionApiMethod(since={8,0,0})
        public void SetGroupProvisioningDefaults(InfoTable groupDefaults)
                                                                                      throws java.lang.Exception
        Service Category:
        SCIM
        Service Description:
        Set the Group Provisioning Defaults.
        Parameters:
        groupDefaults - The group provisioning group defaults - INFOTABLE
        Throws:
        java.lang.Exception - If an error occurs
      • SetProvisioningUserGroupMappings

        @ThingworxExtensionApiMethod(since={8,0})
        public void SetProvisioningUserGroupMappings(InfoTable groupMappings)
                                                                                        throws java.lang.Exception
        Service Category:
        SSO
        Service Description:
        Sets group mappings between the Identity Provider and Thingworx.
        Parameters:
        groupMappings - User Provisioning group mappings - INFOTABLE
        Throws:
        java.lang.Exception - If an error occurs
      • GetProvisioningUserGroupMappings

        @ThingworxExtensionApiMethod(since={8,0})
        public InfoTable GetProvisioningUserGroupMappings()
                                                                                             throws java.lang.Exception
        Service Category:
        SSO
        Service Description:
        Returns group mappings between the Identity Provider and Thingworx.
        Returns:
        result User Provisioning group mappings - INFOTABLE - Aspects {dataShape:UserProvisioningUserGroupMappings}
        Throws:
        java.lang.Exception - If an error occurs