external_sync
Protocol buffer definition for external_sync
sift/external_sync/v1/external_sync.proto
ExternalSync
| Field | Type | Label | Description |
|---|---|---|---|
| organization_id | string | ||
| most_recent_sync_date | google.protobuf.Timestamp | optional | |
| most_recent_sync_by_user_id | string | optional | |
| scim_server_url | string | ||
| token_created_date | google.protobuf.Timestamp | optional | |
| token_lifetime_seconds | uint32 | ||
| most_recent_token_by_user_id | string | optional |
ExternalSyncToken
The actual token value is not returned after it is first generated.
| Field | Type | Label | Description |
|---|---|---|---|
| token_id | string | ||
| lifetime_seconds | uint32 | ||
| created_date | google.protobuf.Timestamp | ||
| created_by_user_id | string |
GenerateTokenRequest
GenerateTokenResponse
| Field | Type | Label | Description |
|---|---|---|---|
| external_sync | ExternalSync | ||
| token | string |
GetExternalSyncRequest
GetExternalSyncResponse
| Field | Type | Label | Description |
|---|---|---|---|
| success | bool | ||
| external_sync | ExternalSync |
ListExternalSyncTokensRequest
| Field | Type | Label | Description |
|---|---|---|---|
| page_size | uint32 | The maximum number of tokens to return. The service may return fewer than this value. If unspecified, at most 50 tokens will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. Optional. | |
| page_token | string | A page token, received from a previous ListExternalSyncTokens call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListExternalSyncTokens must match the call that provided the page token. Optional. | |
| filter | string | A Common Expression Language (CEL) filter string. There are currently no available fields. For further information about how to use CELs, please refer to this guide. | |
| order_by | string | How to order the retrieved user defined functions. Formatted as a comma-separated string i.e. "FIELD_NAME[ desc],...". Available field to order_by is created_date. If left empty, items are ordered by created_date in descending order (newest-first). For more information about the format of this field, read this Example: "created_date asc". |
ListExternalSyncTokensResponse
| Field | Type | Label | Description |
|---|---|---|---|
| external_sync_tokens | ExternalSyncToken | repeated | |
| next_page_token | string |
SyncOrganizationRequest
SyncOrganizationResponse
| Field | Type | Label | Description |
|---|---|---|---|
| external_sync | ExternalSync | ||
| existing_user_count | uint32 | ||
| added_to_organization_user_ids | string | repeated | |
| created_users | sift.common.type.v1.User | repeated | |
| deactivated_user_ids | string | repeated | |
| existing_group_count | uint32 | ||
| created_user_groups | sift.user_groups.v2.UserGroup | repeated | |
| deleted_user_group_names | string | repeated |
ExternalSyncService
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| SyncOrganization | SyncOrganizationRequest | SyncOrganizationResponse | |
| GenerateToken | GenerateTokenRequest | GenerateTokenResponse | |
| GetExternalSync | GetExternalSyncRequest | GetExternalSyncResponse | |
| ListExternalSyncTokens | ListExternalSyncTokensRequest | ListExternalSyncTokensResponse |