Identity Provider API, REST: SynchronizationSession.CloseSession

Field

Description

sessionId

string

Required field. ID of the session to close.

The maximum string length in characters is 50.

Field

Description

failed

boolean

Whether the session failed.

failReason

string

Reason for session failure, if any.

The maximum string length in characters is 256.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

createdAt

string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

createdBy

string

ID of the user or service account who initiated the operation.

modifiedAt

string (date-time)

The time when the Operation resource was last modified.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

done

boolean

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

CloseSessionMetadata

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

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

SynchronizationSession

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.

Field

Description

sessionId

string

ID of the session.

Field

Description

code

integer (int32)

Error code. An enum value of google.rpc.Code.

message

string

An error message.

details[]

object

A list of messages that carry the error details.

Field

Description

sessionId

string

Unique identifier of the session.

agentId

string

ID of the agent managing the session.

createdAt

string (date-time)

Timestamp when the session was created.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

expiresAt

string (date-time)

Timestamp when the session expires.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

closedAt

string (date-time)

Timestamp when the session was closed.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

syncMode

enum (SyncMode)

Synchronization mode.

• FULL_SYNC: Full synchronization mode.
• DELTA: Delta synchronization mode.

status

enum (SessionStatus)

Current status of the session.

• OPENED: Session is opened.
• PENDING: Session is pending.
• COMPLETED: Session is completed.
• FAILED: Session has failed.
• EXPIRED: Session has expired.

progressEntries[]

ProgressEntry

List of progress entries.

failReason

string

Reason for session failure, if any.

sessionType

enum (SessionType)

Type of synchronization session.

• AD_SYNC: Active Directory synchronization session.
• AD_PASSWORD_HASH: Active Directory password hash session.
• AD_USER_CONTROL: Active Directory user control session.

Field

Description

objectType

enum (RelatedObjectType)

Required field. Type of object being synchronized.

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

changeInfo[]

ChangeInfo

List of change information.

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

Field

Description

changeType

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

string (int64)

Number of successful changes.

failed

string (int64)

Number of failed changes.