Sync Service SmartObjects

Use the Sync Service SmartObjects to interact with the Sync Service on K2 Five. K2 recommends that you do not modify these SmartObjects in any way as these are system SmartObjects and may be updated in a future release.

See the Sync Service topic in this guide for information on the service and KB002707: Identity Synchronizing and Caching for information on enabling the service in your system

SmartObject Methods

The Sync Service SmartObjects let you do the following:

SmartObject Description
Operation Gets or sets a sync schedule or manually starts a sync
Provider Contains methods used to list and interact with providers
Run History Gets run history entries by date or status
Provider Instance Contains methods used to list and interact with provider instances
Provider Instance Runtime Config Delete, get and set methods for provider instance runtime configuration
Provider Type List provider types method

Use the methods of the Operation SmartObject to start a sync or configure a sync schedule.

Properties

Name Type Example Notes
ProviderName Text K2 Name of the security label in the K2 database
ProviderInstanceName Text Denallix The domain section of a FQN
ProviderInstanceID Number 1 Unique number auto-assigned to each instance
Schedule Time 00:08:00:00 Format: DD:HH:MM:SS

Methods

Method Description Properties
Start Sync Manually starts a sync with an identity provider Provider Name
Provider Instance Name
Get Provider Schedule Retrieves the time a sync for a provider is scheduled Provider Name
Provider Instance Name
Set Provider Schedule Set a sync schedule for an identity provider Provider Name
Provider Instance Name
Schedule

Use the methods of the Provider Sync Service SmartObject to see a list existing providers and associated information.

Properties

Name Type Example Notes
ProviderID Number 1 Unique ID per provider representing a security label
ProviderName Text K2 Providers are identified by the K2 security label, for example, "K2" is Active Directory
ProviderTypeID Number 2 the ID that matches the provider type
ProviderType Text AD This is the type of provider, for example AD or SharePoint
Enabled Boolean Yes Yes or No

Methods

Method Description Properties
Add Provider Adds a provider (security label) to the K2 database Provider Name
Provider Type
Enabled
Delete Provider Removes a provider (security label) from the K2 database Provider Name
Get Provider Retrieves details for the provider (security label) Provider Name
List Providers Retrieves a list of providers in your system N/A
Update Provider Status Enables or disables the provider Provider Name
Enabled

Use the methods of the Provider Instances Sync Service SmartObject to list existing Provider Instances and see associated information on them.

Each SharePoint Site Collection has it's own Provider Instance and the instance name is the same as the Site Collection name. For example, Portal.

Properties

Name Type Example Notes
ProviderID Number 1 Unique ID per provider representing a security label
ProviderInstanceID Number 1 Unique number auto-assigned to an instance
ProviderInstanceName Text Denallix The domain section of a FQN
ProviderName Text K2 Providers are identified by the security label, for example "K2" is Active Directory
SyncState Text Text Encoded text for system use
Enabled Yes/No Yes Yes or No
ActiveServerID Number 1 Number of the server that’s active when using 2 nodes
SyncIntervalMinutes Number 480 The number, in minutes, between syncs. 480 = 8 hours.
LastSync DateTime 2018-10-01T11:00:01 The date and time of the last sync. YYYY-MM-DD HH:MM:SS

Methods

Method Description Properties
Add Provider Instance Creates a provider instance Provider Name
Provider Instance Name
Enabled
Delete Provider Instance Removes a provider instance Provider Name
Provider Instance Name
Get Provider Instance Retrieves details for the provider instance Provider Name
Provider Instance Name
List Providers Instance Retrieves a list of provider instances in your system N/A
Update Provider Instance Status Enables or disables the provider instance Provider Name
Provider Instance Name
Enabled

Use the List Provider Type method of the Provider Types SmartObject to list the Provider Types in your environment.

Properties

Name Type Example Notes
ProviderTypeID Number 1 Unique ID representing a provider type
Type Text   The type of provider, for example AzureAD or Legacy
ProviderTypeExecutingType Text   Returns a value showing the assembly used for the type

Methods

Method Description Properties
List Provider Types Retrieves a list of provider types in your system N/A

Use the methods of the Run History Sync Service SmartObject to see run histories by either date range or status

Properties

Name Type Example Notes
RunHistoryEntryId Number   Unique number auto-assigned to each entry
ProviderInstanceID Number 1 Unique number auto-assigned to each instance
ProviderInstanceName Text Denallix The domain section of a FQN
ProviderName Text K2 Providers are identified by the security label, for example "K2" is Active Directory
RunStatus Text 1, 2, or 3 Shows the outcome of the sync that ran (synchronizing, complete, failed)
SyncStart DateTime 2018-10-01T11:00:01 The date and time when the sync started. YYYY-MM-DD HH:MM:SS
SyncEnd DateTime 2018-10-01T11:00:01 The date and time when the sync ended. YYYY-MM-DD HH:MM:SS
IdentityCount Number 15000 Membership count
LinkCount Number 15000 Property count. These include Name, Email, and more
PropertyCount Number    

Methods

Method Description Properties
Get Run History Entries By Date Range Retrieve a list of sync runs in a date range Provider Name
Provider Instance Name
Sync Start
Sync End
Get Run History Entries By Status Retrieve a list of sync runs based on the status: Synchronizing, Complete, Failed Provider Name
Provider Instance Name
Run Status

The Provider Instance Runtime Config is the information the provider needs to query the IdP. For example, to query SharePoint this would be your SiteURL and resourceId, for AAD this would be your directoryId.

This SmartObject is for internal use only.

Properties

Name Type Example Notes
ProviderInstanceName Text Denallix The domain section of a FQN
ProviderName Text K2 Providers are identified by the K2 security label e.g. K2 is Active Directory by default.
ProviderInstanceID Number 1 Unique number auto-assigned to each instance
ProviderInstanceRuntimeConfig Number 1 Provider instance configuration settings
ConfigKey Text NetBiosName Any configuration setting related to Identity
ConfigValue Text   Value setting for the config key

Methods

Method Description Properties
Delete Provider Instance Runtime Config Entries Deletes all RoleInit configuration lines for provider instance data Provider Name
Provider Instance Name
Delete Provider Instance Runtime Config Entry Deletes a single RoleInit configuration line for a provider instance Provider Name
Provider Instance Name
Config Key
Get Provider Instance Runtime Config Entry Retrieves the runtime configuration for the provider instance Provider Name
Provider Instance Name
Set Provider Instance Runtime Config Entry Sets the runtime configuration for the provider instance Provider Name
Provider Instance Name
Config Key
Config Value