Identity Provider API, gRPC: SynchronizationSessionService.ReportSessionProgress

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

Yandex Cloud

Обновлена 27 мая 2026 г.

gRPC request
ReportSessionProgressRequest
ProgressEntry
ChangeInfo
operation.Operation

Reports progress for a synchronization session.

gRPC request

rpc ReportSessionProgress (ReportSessionProgressRequest) returns (operation.Operation)

ReportSessionProgressRequest

{
  "session_id": "string",
  "progress_entries": [
    {
      "object_type": "RelatedObjectType",
      "change_info": [
        {
          "change_type": "ChangeType",
          "successful": "int64",
          "failed": "int64"
        }
      ]
    }
  ]
}

Request to report session progress.

Field

Description

session_id

string

Required field. ID of the session.

The maximum string length in characters is 50.

progress_entries[]

ProgressEntry

List of progress entries.

The number of elements must be in the range 1-3.

ProgressEntry

Progress entry for synchronization.

Field

Description

object_type

enum RelatedObjectType

Required field. Type of object being synchronized.

USER: User object.
GROUP: Group object.
MEMBERSHIP: Membership object.

change_info[]

ChangeInfo

List of change information.

The number of elements must be in the range 1-6.

ChangeInfo

Information about changes during synchronization.

Field	Description
change_type	enum ChangeType Type of change. `CREATE`: Create operation. `UPDATE`: Update operation. `DELETE`: Delete operation. `ACTIVATE`: Activate operation. `DEACTIVATE`: Deactivate operation. `PASSWORD_HASH_UPDATE`: Password hash update operation.
successful	int64 Number of successful changes.
failed	int64 Number of failed changes.

operation.Operation

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

Identity Provider API, gRPC: SynchronizationSessionService.ReportSessionProgress

gRPC requestgRPC request

ReportSessionProgressRequestReportSessionProgressRequest

ProgressEntryProgressEntry

ChangeInfoChangeInfo

operation.Operationoperation.Operation

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

gRPC request

ReportSessionProgressRequest

ProgressEntry

ChangeInfo

operation.Operation