Sync Service SmartObjects
Use the
See
SmartObject Methods
The sync service SmartObjects allow you to do the following:
| SmartObject | Description |
|---|---|
| Operation | Gets or sets a sync schedule or manually starts a sync |
| Provider | Contains methods used to list providers |
| Run History | Gets run history entries by date or status |
| Provider Instance | Contains methods used to list provider instances |
| Provider Instance Runtime Config | Gets, sets, and deletes provider instance runtime configuration (reserved for internal use) |
| Provider Type | List provider types method |
Operations
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:07:00:00 | Format: DD:HH:MM:SS |
| SkipDeleted | Boolean | Yes | Yes or No |
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 with an identity 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 |
Provider
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 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 |
Provider Instance
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 its own Provider Instance and the instance name is 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 multiple nodes |
| SyncIntervalMinutes | Number | 480 | The number, in minutes, between syncs. 420 minutes is 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 |
Provider Type
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 |
Run History
Use the methods of the Run History SmartObject to see sync 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 in an Active Directory environments |
| 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 | Links are relationships between identities. Group membership is considered a link as well as manager-direct report relationships. This count represents the number of group membership and manager-direct report relationships which are included in this sync instance. This number provides some insight into the complexity of your environment. |
| PropertyCount | Number | The number of user and group properties changes (for example, a change in user or group name) included in this sync run. |
Methods
| Method | Description | Properties |
|---|---|---|
| Get Run History Entries By Date Range | Retrieve a list of syncs in a date range | Provider Name |
| Provider Instance Name | ||
| Sync Start | ||
| Sync End | ||
| Get Run History Entries By Status | Retrieve a list of syncs based on the status: Synchronizing, Complete, Failed | Provider Name |
| Provider Instance Name | ||
| Run Status |
Provider Instance Runtime Config (reserved for internal use)
The Provider Instance Runtime Config SmartObject contains the information the provider needs to query the IdP.
This SmartObject is for internal use only.