Identity Provider API, REST: SynchronizationSession.ListSessions

Field

Description

subjectContainerId

string

Required field. ID of the subject container.

The maximum string length in characters is 50.

pageSize

string (int64)

The maximum number of results per page to return.

Acceptable values are 0 to 1000, inclusive.

pageToken

string

Page token for pagination.

The maximum string length in characters is 2000.

filter

string

A filter expression that filters resources listed in the response.

The maximum string length in characters is 1000.

Field

Description

sessions[]

SynchronizationSession

List of synchronization sessions.

nextPageToken

string

Token for getting the next page of the list.

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.