Package com.thingworx.system.subsystems.scim

Class SCIMSubsystem

java.lang.Object
com.thingworx.types.NamedObject
com.thingworx.persistence.common.PersistableNamedObject
com.thingworx.entities.RootEntity
com.thingworx.entities.ServiceProviderEntity
com.thingworx.entities.ExtensibleRootEntity
com.thingworx.system.subsystems.Subsystem
com.thingworx.system.subsystems.scim.SCIMSubsystem
All Implemented Interfaces:
IConfigurableObject, INotScriptFriendly, ISupportsDeprecation, IDiffableObject, IAvatar, IEntityLifeCycleEvent, IPersistable, IServiceProvider, ITaggableObject, IDependencyScannableObject, IEntityDefinition, IPersistableObject<String>, IDesignTimeSecurable, IDesignTimeSecurableEntity, IRunTimeSecurable, IRunTimeSecurableEntity, ISecurable, IVisibilitySecurable, IVisibilitySecurableEntity, IAspectContainer, INamedObject, Serializable
@ThingworxExtensionApiClass(since={8,0,0}, canInstantiate=true) public class SCIMSubsystem extends Subsystem
See Also:

  • Constructor Details Link icon

    • SCIMSubsystem Link icon

      public SCIMSubsystem()

  • Method Details Link icon

    • validateConfiguration Link icon

      @ThingworxExtensionApiMethod(since={7,3}) public void validateConfiguration(ImportedEntityCollection importedEntityCollections) throws 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:
      Exception - If an error occurs

    • GetProvisioningOptions Link icon

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

    • SetProvisioningOptions Link icon

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

    • GetUserProvisioningExclusionList Link icon

      @ThingworxExtensionApiMethod(since={8,0,0}) public InfoTable GetUserProvisioningExclusionList() throws 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:
      Exception - If an error occurs

    • SetUserProvisioningExclusionList Link icon

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

    • GetUserProvisioningDefaults Link icon

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

    • SetUserProvisioningDefaults Link icon

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

    • GetGroupProvisioningExclusionList Link icon

      @ThingworxExtensionApiMethod(since={8,0,0}) public InfoTable GetGroupProvisioningExclusionList() throws 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:
      Exception - If an error occurs

    • SetGroupProvisioningExclusionList Link icon

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

    • GetGroupProvisioningDefaults Link icon

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

    • SetGroupProvisioningDefaults Link icon

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

    • SetProvisioningUserGroupMappings Link icon

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

    • GetProvisioningUserGroupMappings Link icon

      @ThingworxExtensionApiMethod(since={8,0}) public InfoTable GetProvisioningUserGroupMappings() throws 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:
      Exception - If an error occurs