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, IDiffableObject, IAvatar, IEntityLifeCycleEvent, IPersistable, IServiceProvider, ITaggableObject, IDependencyScannableObject, IEntityDefinition, IPersistableObject<java.lang.String>, IDesignTimeSecurable, IDesignTimeSecurableEntity, IRunTimeSecurable, IRunTimeSecurableEntity, ISecurable, IVisibilitySecurable, IVisibilitySecurableEntity, IAspectContainer, INamedObject, java.io.Serializable

@ThingworxExtensionApiClass(since={8,0,0},
                            canInstantiate=true)
public class SCIMSubsystem
extends Subsystem

See Also:

Serialized Form

Field Summary

Fields inherited from class com.thingworx.system.subsystems.Subsystem

DEFAULT_AUTOSTART, DEFAULT_ENABLED, METRICS_DATA_SHAPE

Fields inherited from class com.thingworx.entities.RootEntity

BASIC_PROPERTIES

Fields inherited from class com.thingworx.types.NamedObject

NAME_COMPARATOR

Constructor Summary

Constructors

Constructor and Description
SCIMSubsystem()

Method Summary

Modifier and Type	Method and Description
InfoTable	GetGroupProvisioningDefaults() Service Category: SCIM Service Description: Return the Group Provisioning Group Default Settings.
InfoTable	GetGroupProvisioningExclusionList() Service Category: SCIM Service Description: Return the Group Provisioning Exclusion List.
InfoTable	GetProvisioningOptions() Service Category: SSO Service Description: Returns Provisioning Options.
InfoTable	GetProvisioningUserGroupMappings() Service Category: SSO Service Description: Returns group mappings between the Identity Provider and Thingworx.
InfoTable	GetUserProvisioningDefaults() Service Category: SCIM Service Description: Return the User Provisioning User Default Settings.
InfoTable	GetUserProvisioningExclusionList() Service Category: SCIM Service Description: Return the User Provisioning Exclusion List.
void	SetGroupProvisioningDefaults(InfoTable groupDefaults) Service Category: SCIM Service Description: Set the Group Provisioning Defaults.
void	SetGroupProvisioningExclusionList(InfoTable groups) Service Category: SCIM Service Description: Set the Group Provisioning Exclusion List.
void	SetProvisioningOptions(InfoTable provisioningOptions) Service Category: SSO Service Description: Sets Provisioning Options.
void	SetProvisioningUserGroupMappings(InfoTable groupMappings) Service Category: SSO Service Description: Sets group mappings between the Identity Provider and Thingworx.
void	SetUserProvisioningDefaults(InfoTable userDefaults) Service Category: SCIM Service Description: Set the User Provisioning Defaults.
void	SetUserProvisioningExclusionList(InfoTable users) Service Category: SCIM Service Description: Set the User Provisioning Exclusion List.
void	validateConfiguration(ImportedEntityCollection importedEntityCollections)

Methods inherited from class com.thingworx.system.subsystems.Subsystem

getDependsOn, getEntityType, getFriendlyName, GetPerformanceMetrics, getSubsystemPerformanceMetrics, getSubsystemState, GetSubsystemState, initializeSubsystem, isAutoStart, isEnabled, isRunning, IsRunning, ResetPerformanceMetrics, resetSubsystemPerformanceMetrics, Restart, setAutoStart, setDependsOn, setFriendlyName, setRunning, Start, startSubsystem, Stop, stopSubsystem

Methods inherited from class com.thingworx.entities.ServiceProviderEntity

getInstancePublicServiceDefinitions, getInstanceServiceDefinition, getInstanceServiceDefinitions, initializeEntity, preInitializeEntity, processAPIServiceRequest, processServiceRequest

Methods inherited from class com.thingworx.entities.RootEntity

AddConfigurationTableDefinition, addDesignTimePermission, AddDesignTimePermission, addRunTimePermission, AddRunTimePermission, AddTags, addVisibilityPermission, AddVisibilityPermission, CheckDesignTimePermission, CheckDesignTimePermissionForGroup, CheckDesignTimePermissionForUser, CheckPermission, CheckPermissionForGroup, CheckPermissionForUser, cleanupEntity, cleanupEntity, DeleteAllConfigurationTableRows, DeleteConfigurationTable, DeleteConfigurationTableRows, deleteDesignTimePermission, DeleteDesignTimePermission, deleteRunTimePermission, DeleteRunTimePermission, deleteVisibilityPermission, DeleteVisibilityPermission, dispose, getAspects, GetAvatar, getAvatarContent, GetAvatarURL, GetConfigurationChangeHistory, getConfigurationSetting, getConfigurationTable, GetConfigurationTable, GetConfigurationTableDefinition, GetConfigurationTableRow, GetConfigurationTables, GetDescription, getDesignTimePermissions, GetDesignTimePermissions, GetDesignTimePermissionsAsJSON, getDocumentationContent, getEntityTypeAsString, GetEventDefinition, GetEventDefinitions, GetHomeMashup, GetIncomingDependencies, GetIncomingDependenciesAsNetwork, GetInstanceMetadataAsJSON, GetInstanceMetadataWithPermissionsAsJSON, GetLastModifiedDate, GetMetadata, GetMetadataAsJSON, GetMetadataWithPermissionsAsJSON, GetOutgoingDependencies, GetOutgoingDependenciesAsNetwork, getOwner, GetPermissionsForCurrentUser, GetPermissionsForGroup, GetPermissionsForUser, GetProjectName, GetPropertyDefinition, GetPropertyDefinitions, getRunTimePermissions, GetRunTimePermissions, GetRunTimePermissionsAsJSON, GetServiceDefinition, GetServiceDefinitions, getStringConfigurationSetting, getStringConfigurationSettingWithDefault, GetSummaryInformation, getTags, GetTags, GetTagsAsInfoTable, getVisibilityPermissions, GetVisibilityPermissions, GetVisibilityPermissionsAsJSON, HasIncomingDependencies, HasOutgoingDependencies, isEditable, isEditableExtensionObject, isEditableSystemObject, isExtensionObject, IsMultiRowTable, isOwner, isSystemObject, isThemeObject, isVisible, isVisible, persistDesignTimePermissions, persistRunTimePermissions, persistVisibilityPermissions, RemoveTags, SaveConfigurationTables, SetAvatar, setConfigurationSetting, SetConfigurationTable, SetConfigurationTableRows, SetDescription, setDesignTimePermissions, SetDesignTimePermissionsAsJSON, setDocumentationContent, setExtensionObject, SetHomeMashup, setLastModifiedDate, SetMultiRowConfigurationTable, setOwner, SetOwner, SetProjectName, setRunTimePermissions, SetRunTimePermissionsAsJSON, setStringConfigurationSetting, SetTags, setVisibilityPermissions, SetVisibilityPermissionsAsJSON, toJSON, toJSONDefinition

Methods inherited from class com.thingworx.persistence.common.PersistableNamedObject

getID, hasID, isTransient

Methods inherited from class com.thingworx.types.NamedObject

getDescription, getName, setDescription, setName, toValueCollection

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.thingworx.entities.interfaces.IPersistable

getID, hasID

Methods inherited from interface com.thingworx.types.INamedObject

getDescription, getName

Methods inherited from interface com.thingworx.security.permissions.ISecurable

getID, getName

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