Identity Provider API, gRPC: SynchronizationService.GetSynchronizationSettings
Returns synchronization settings for a subject container.
gRPC request
rpc GetSynchronizationSettings (GetSynchronizationSettingsRequest) returns (SynchronizationSettings)
GetSynchronizationSettingsRequest
{
"subject_container_id": "string"
}
Request to get synchronization settings.
|
Field |
Description |
|
subject_container_id |
string Required field. ID of the subject container. The maximum string length in characters is 50. |
SynchronizationSettings
{
"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"
}
Synchronization settings for a subject container.
|
Field |
Description |
|
subject_container_id |
string ID of the subject container. |
|
filter |
Filter configuration for synchronization. |
|
remove_user_behavior |
enum RemoveUserBehavior Behavior when removing users.
|
|
synchronization_interval |
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[] |
User attribute mappings. |
|
group_attribute_mappings[] |
Group attribute mappings. |
|
created_at |
Timestamp when the settings were created. |
|
replacement_domain |
string Domain replacement configuration. |
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.
|
|
type |
enum MappingType Required field. Type of mapping.
|
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.
|
|
type |
enum MappingType Required field. Type of mapping.
|