Identity Provider API, gRPC: SynchronizationSessionService.GetSession
Returns the specified synchronization session.
gRPC request
rpc GetSession (GetSessionRequest) returns (GetSessionResponse)
GetSessionRequest
{
"session_id": "string"
}
Request to get a synchronization session.
|
Field |
Description |
|
session_id |
string Required field. ID of the session to return. The maximum string length in characters is 50. |
GetSessionResponse
{
"session": {
"session_id": "string",
"agent_id": "string",
"created_at": "google.protobuf.Timestamp",
"expires_at": "google.protobuf.Timestamp",
"closed_at": "google.protobuf.Timestamp",
"sync_mode": "SyncMode",
"status": "SessionStatus",
"progress_entries": [
{
"object_type": "RelatedObjectType",
"change_info": [
{
"change_type": "ChangeType",
"successful": "int64",
"failed": "int64"
}
]
}
],
"fail_reason": "string",
"session_type": "SessionType"
}
}
Response message for SynchronizationSessionService.GetSession.
|
Field |
Description |
|
session |
Synchronization session information. |
SynchronizationSession
Synchronization session information.
|
Field |
Description |
|
session_id |
string Unique identifier of the session. |
|
agent_id |
string ID of the agent managing the session. |
|
created_at |
Timestamp when the session was created. |
|
expires_at |
Timestamp when the session expires. |
|
closed_at |
Timestamp when the session was closed. |
|
sync_mode |
enum SyncMode Synchronization mode.
|
|
status |
enum SessionStatus Current status of the session.
|
|
progress_entries[] |
List of progress entries. |
|
fail_reason |
string Reason for session failure, if any. |
|
session_type |
enum SessionType Type of synchronization session.
|
ProgressEntry
Progress entry for synchronization.
|
Field |
Description |
|
object_type |
enum RelatedObjectType Required field. Type of object being synchronized.
|
|
change_info[] |
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.
|
|
successful |
int64 Number of successful changes. |
|
failed |
int64 Number of failed changes. |