Identity Provider API, gRPC: SynchronizationService.CreateSynchronizationSettings

Статья создана

Yandex Cloud

Обновлена 15 декабря 2025 г.

gRPC request
CreateSynchronizationSettingsRequest
SynchronizationFilter
UserAttributeMapping
GroupAttributeMapping
operation.Operation
CreateSynchronizationSettingsMetadata
SynchronizationSettings
SynchronizationFilter
UserAttributeMapping
GroupAttributeMapping

Creates synchronization settings for a subject container.

gRPC request

rpc CreateSynchronizationSettings (CreateSynchronizationSettingsRequest) returns (operation.Operation)

CreateSynchronizationSettingsRequest

{
  "subject_container_id": "string",
  "filter": {
    "domain": "string",
    "groups": [
      "string"
    ],
    "organization_units": [
      "string"
    ]
  },
  "replacement_domain": "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"
    }
  ]
}

Request to create synchronization settings.

Field	Description
subject_container_id	string Required field. ID of the subject container. The maximum string length in characters is 50.
filter	SynchronizationFilter Required field. Filter configuration for synchronization.
replacement_domain	string Domain replacement configuration. The string length in characters must be 0-253.
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. The maximum number of elements is 50.
group_attribute_mappings[]	GroupAttributeMapping Group attribute mappings. The maximum number of elements is 50.

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.
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).

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "subject_container_id": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "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"
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
metadata	CreateSynchronizationSettingsMetadata Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
error	google.rpc.Status The error result of the operation in case of failure or cancellation. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.
response	SynchronizationSettings The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.

CreateSynchronizationSettingsMetadata

Metadata for the SynchronizationService.CreateSynchronizationSettings operation.

Field

Description

subject_container_id

string

ID of the subject container.

SynchronizationSettings

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.

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.
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.CreateSynchronizationSettings

gRPC requestgRPC request

CreateSynchronizationSettingsRequestCreateSynchronizationSettingsRequest

SynchronizationFilterSynchronizationFilter

UserAttributeMappingUserAttributeMapping

GroupAttributeMappingGroupAttributeMapping

operation.Operationoperation.Operation

CreateSynchronizationSettingsMetadataCreateSynchronizationSettingsMetadata

SynchronizationSettingsSynchronizationSettings

SynchronizationFilterSynchronizationFilter

UserAttributeMappingUserAttributeMapping

GroupAttributeMappingGroupAttributeMapping

Была ли статья полезна?

gRPC request

CreateSynchronizationSettingsRequest

SynchronizationFilter

UserAttributeMapping

GroupAttributeMapping

operation.Operation

CreateSynchronizationSettingsMetadata

SynchronizationSettings

SynchronizationFilter

UserAttributeMapping

GroupAttributeMapping