Identity Provider API, REST: Synchronization.GetSynchronizationSettings
Returns synchronization settings for a subject container.
HTTP request
GET https://organization-manager.api.yandexcloud.kz/organization-manager/v1/idp/synchronization-settings/{subjectContainerId}
Path parameters
Request to get synchronization settings.
|
Field |
Description |
|
subjectContainerId |
string Required field. ID of the subject container. The maximum string length in characters is 50. |
Response
HTTP Code: 200 - OK
{
"subjectContainerId": "string",
"filter": {
"domain": "string",
"groups": [
"string"
],
"organizationUnits": [
"string"
]
},
"removeUserBehavior": "string",
"synchronizationInterval": "string",
"allowToCaptureUsers": "boolean",
"allowToCaptureGroups": "boolean",
"userAttributeMappings": [
{
"source": "string",
"target": "string",
"type": "string"
}
],
"groupAttributeMappings": [
{
"source": "string",
"target": "string",
"type": "string"
}
],
"createdAt": "string",
"replacementDomain": "string"
}
Synchronization settings for a subject container.
|
Field |
Description |
|
subjectContainerId |
string ID of the subject container. |
|
filter |
Filter configuration for synchronization. |
|
removeUserBehavior |
enum (RemoveUserBehavior) Behavior when removing users.
|
|
synchronizationInterval |
string (duration) Interval between synchronization runs. |
|
allowToCaptureUsers |
boolean Whether users can be captured during synchronization. |
|
allowToCaptureGroups |
boolean Whether groups can be captured during synchronization. |
|
userAttributeMappings[] |
User attribute mappings. |
|
groupAttributeMappings[] |
Group attribute mappings. |
|
createdAt |
string (date-time) Timestamp when the settings were created. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
replacementDomain |
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. |
|
organizationUnits[] |
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.
|