Identity Provider API, gRPC: SynchronizationService.GetSynchronizationSettings

Field

Description

subject_container_id

string

Required field. ID of the subject container.

The maximum string length in characters is 50.

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.

ldap_settings

LdapSettings

Settings for generic LDAP synchronization source.

Empty for Active Directory source. Required and fully populated for
generic LDAP source.

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.

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).
• DIRECT_ARBITRARY_ATTRIBUTE: Direct mapping from an arbitrary source attribute

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).
• DIRECT_ARBITRARY_ATTRIBUTE: Direct mapping from an arbitrary source attribute

Field

Description

external_id_attribute

string

Name of the LDAP attribute that holds the unique entry identifier.

dn_attribute

string

Name of the LDAP attribute that holds the DN of the entry.

user_object_class

string

ObjectClass of users.

group_object_class

string

ObjectClass of groups.

account_disabled_attribute

string

Name of the LDAP attribute that stores the account status.

account_disabled_value

string

Value of account_disabled_attribute meaning the account is disabled.

account_enabled_value

string

Value of account_disabled_attribute meaning the account is enabled.

password_attribute

string

Name of the LDAP attribute the agent writes the new password to during
password writeback.

delta_sync_mode

enum LdapDeltaSyncMode

Delta synchronization mode.

• LDAP_DELTA_SYNC_MODE_FULL_SYNC: Every run is a full sync; no replication token is used.

use_recursive_membership_filter

bool

Enables the AD-extension matching rule
1.2.840.113556.1.4.1941 for the group-DN membership filter.