{
  "subject_container_id": "string",
  "filter": {
    "domain": "string",
    "groups": [
      "string"
    ],
    "organization_units": [
      "string"
    ]
  },
  "remove_user_behavior": "RemoveUserBehavior",
  "synchronization_interval": "google.protobuf.Duration",
  "allow_to_capture_users": "bool",
  "allow_to_capture_groups": "bool",
  "user_attribute_mappings": [
    {
      "source": "string",
      "target": "UserTargetAttribute",
      "type": "MappingType"
    }
  ],
  "group_attribute_mappings": [
    {
      "source": "string",
      "target": "GroupTargetAttribute",
      "type": "MappingType"
    }
  ],
  "created_at": "google.protobuf.Timestamp",
  "replacement_domain": "string",
  "enable_password_writeback": "bool"
}

Synchronization settings for a subject container.

Field	Description
subject_container_id	string ID of the subject container.
filter	SynchronizationFilter Filter configuration for synchronization.
remove_user_behavior	enum RemoveUserBehavior Behavior when removing users. `REMOVE`: Remove the user. `BLOCK`: Block the user.
synchronization_interval	google.protobuf.Duration Interval between synchronization runs.
allow_to_capture_users	bool Whether users can be captured during synchronization.
allow_to_capture_groups	bool Whether groups can be captured during synchronization.
user_attribute_mappings[]	UserAttributeMapping User attribute mappings.
group_attribute_mappings[]	GroupAttributeMapping Group attribute mappings.
created_at	google.protobuf.Timestamp Timestamp when the settings were created.
replacement_domain	string Domain replacement configuration.
enable_password_writeback	bool Enables password writeback feature.

SynchronizationFilter

Filter configuration for synchronization.

Field	Description
domain	string Required field. Domain to synchronize. The string length in characters must be 1-253.
groups[]	string List of groups to synchronize. The string length in characters for each value must be 1-253. The maximum number of elements is 10.
organization_units[]	string List of organizational units to synchronize. The string length in characters for each value must be 1-253. The maximum number of elements is 10.

UserAttributeMapping

User attribute mapping configuration.

Field	Description
source	string Source attribute name. The string length in characters must be 0-253.
target	enum UserTargetAttribute Required field. Target attribute to map to. `FULL_NAME`: Full name attribute. `GIVEN_NAME`: Given name attribute. `FAMILY_NAME`: Family name attribute. `EMAIL`: Email attribute. `PHONE_NUMBER`: Phone number attribute. `USERNAME`: Username attribute. `COMPANY_NAME`: Company name attribute. `JOB_TITLE`: Job title attribute. `DEPARTMENT`: Department attribute. `EMPLOYEE_ID`: Employee ID attribute.
type	enum MappingType Required field. Type of mapping. `DIRECT`: Direct mapping from source to target. `EMPTY`: Empty mapping (no source attribute).

GroupAttributeMapping

Group attribute mapping configuration.

Field	Description
source	string Source attribute name. The string length in characters must be 0-253.
target	enum GroupTargetAttribute Required field. Target attribute to map to. `NAME`: Name attribute. `DESCRIPTION`: Description attribute.
type	enum MappingType Required field. Type of mapping. `DIRECT`: Direct mapping from source to target. `EMPTY`: Empty mapping (no source attribute).

Identity Provider API, gRPC: SynchronizationService.GetSynchronizationSettings

gRPC requestgRPC request

GetSynchronizationSettingsRequestGetSynchronizationSettingsRequest

SynchronizationSettingsSynchronizationSettings

SynchronizationFilterSynchronizationFilter

UserAttributeMappingUserAttributeMapping

GroupAttributeMappingGroupAttributeMapping

Was the article helpful?

gRPC request

GetSynchronizationSettingsRequest

SynchronizationSettings

SynchronizationFilter

UserAttributeMapping

GroupAttributeMapping