WebCenter Interaction API  
 

IPTAuthSource Members

IPTAuthSource overview

Public Instance Methods

public methodCreateRemoteUser Creates a remote user against the specified authentication source. This function does not replace a user synchronization, but instead allows a user to be created against an authentication source in a one-off manner between user synchronizations. All attributes of the user, as imported via this function, will be preserved and properly updated by regular user syncs.
public methodEnableAgentDisabledUsers Enable "agent-disabled" users, and return the number of users that were re-enabled. An "agent-disabled" users is one that was disabled during a synchronization job. Many users can sometimes be disabled due to various synchroanization errors - this function allows them to be quickly re-enabled.
public methodGetAgentDisabledUsersCount Get the number of "agent-disabled" users currently disabled by an agent on this auth source.
public methodGetAuthPartnerID Returns the ID of the authentication partner, or 0 for no partner. The auth partner, if any, is used to authenticate users from this auth source.
public methodGetBulkCopyNum Returns the maximum number of database rows which can be inserted at a time during user sync.
public methodGetDefaultProfileForNewUsers Returns the id of the default profile which will be applied to users imported by this auth source.
public methodGetDefaultProfilesMap_FolderIDs Returns the array of folder ids from the default profiles map.
public methodGetDefaultProfilesMap_GroupIDs Returns the array of group ids from the default profiles map.
public methodGetDefaultProfilesMap_UserIDs Returns the array of default profile ids from the default profiles map.
public methodGetDeletedGroupFolderID Returns the id of the admin folder where deleted groups will be moved. If 0, groups will be deleted instead of moved.
public methodGetDeletedUserFolderID Returns the id of the admin folder where deleted users will be moved. If 0, users will be deleted instead of disabled and moved.
public methodGetEveryoneGroupID Returns the id of the everyone group for this auth source.
public methodGetFullSyncGroups Returns the list of groups which have been selected for partial users sync. Only members of these groups will be imported.
public methodGetImportCrossASMembers Returns the value of the import memberships from other authentication sources flag.
public methodGetNewGroupFolderID Returns the id of the admin folder where new groups will be created.
public methodGetNewUserFolderID Returns the id of the admin folder where new users will be created.
public methodGetPrefixString Returns the prefix used for users imported by this auth source.
public methodGetProviderCLSID Returns the CLSID of the provider for this auth source.
public methodGetProviderInfo Returns the provider property bag.
public methodGetSupportsSync Returns whether this auth source supports user sync.
public methodGetSyncType Returns the sync gype fo this auth source.
public methodGetUseDefaultProfilesMap Returns whether the default profiles map is used for this auth source. If not, all new users will receive the profile id returned by GetDefaultProfileForNewUsers.
public methodGetWebServiceID Returns the id of the web service associated with this auth source. Only applicable to remote auth sources.
public methodPutEveryoneGroupID Allows the everyone group ID to be set.
public methodSetAuthPartnerID Sets the ID of the authentication partner, or 0 for no partner. The auth partner, if any, is used to authenticate users from this auth source.
public methodSetBulkCopyNum Sets the maximum number of database rows which can be inserted at a time during user sync.
public methodSetDefaultProfileForNewUsers Sets the id of the default profile which will be applied to users imported by this auth source.
public methodSetDefaultProfilesMapOverloaded. Sets the default profiles map, which determines which default profile new users will receive, and into which admin folder they will be placed.
public methodSetDeletedGroupFolderID Sets the id of the admin folder where deleted groups will be created. If 0, groups will be deleted instead of moved.
public methodSetDeletedUserFolderID Sets the id of the admin folder where deleted users will be moved. If 0, users will be deleted instead of disabled and moved.
public methodSetFullSyncGroupsOverloaded. Sets the list of groups which have been selected for partial users sync. Only members of these groups will be imported.
public methodSetImportCrossASMembers Sets a flag that tells the sync agent to import memberships for users imported to other authentication sources. The default behavior is for this feature to be disabled.
public methodSetNewGroupFolderID Sets the id of the admin folder where new groups will be created.
public methodSetNewUserFolderID Sets the id of the admin folder where new users will be created.
public methodSetProviderCLSID Sets the provider CLSID.
public methodSetProviderInfoOverloaded. Sets the provider property bag.
public methodSetSupportsSync Sets whether this auth source supports user sync.
public methodSetSyncType Sets the sync type of this auth source.
public methodSetUseDefaultProfilesMap Sets whether the default profiles map is used for this auth source. If not, all new users will receive the profile id returned by GetDefaultProfileForNewUsers.
public methodSetWebServiceID Returns the id of the web service associated with this auth source. Only applicable to remote auth sources.

See Also

IPTAuthSource Interface | com.plumtree.server Namespace | IPTAuthSourceProvider