afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/ActivityUsrConnectionStatus.json

{
  "sections": [
    "title",
    "description",
    "fields",
    "special_access_rules",
    "field_reference"
  ],
  "title": "ActivityUsrConnectionStatus - Data API",
  "description": "Represents the status of the email connections for Einstein Activity Capture users. You can also see whether users accepted the required terms of service to capture emails. This object is available in API version 54.0 and later.",
  "fields_columns": [
    "type",
    "properties",
    "description"
  ],
  "fields": {
    "ConfigurationName": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The name of the Einstein Activity Capture configuration that the user is assigned to."
    },
    "ConnectivityStatus": {
      "type": "picklist",
      "properties": "Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "The status of the user’s email connection. Possible values are: ACTIVE DISABLED INITIALIZING NEEDSATTENTION NEEDSATTENTIONGLOBAL (used when an org-level connection isn’t working) NEEDSATTENTIONHYBRID (used when both org-level and user-level connections aren’t working) PENDING PROCESSING"
    },
    "ContactsSynced": {
      "type": "int",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The number of contacts synced after midnight between Salesforce and the user’s Microsoft or Google email account. This field is available in API version 59.0 and later."
    },
    "EmailAddress": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The email address that’s used to capture and sync data between Salesforce and the user’s Microsoft or Google account."
    },
    "EventsSynced": {
      "type": "int",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The number of events synced after midnight between Salesforce and the user’s Microsoft or Google email account. This field is available in API version 59.0 and later."
    },
    "ExternalId": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "This field is reserved for future use."
    },
    "GlobalOauthTermsState": {
      "type": "picklist",
      "properties": "Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "Indicates the user’s terms of service status. When emails are enabled for Einstein Activity Capture, each user must accept the terms of service. Possible values are: ACCEPTED DECLINED PENDING This field is available only if you use an org-level OAuth 2.0 or a service account authentication method. In connection report CSV files downloaded from Einstein Activity Capture Status & Metrics, this field is labeled Global Auth User Email Consent Status."
    },
    "IsTermsOfServiceAccepted": {
      "type": "boolean",
      "properties": "Defaulted on create, Filter, Group, Sort",
      "description": "Indicates whether the user has accepted the Einstein Activity Capture terms of service or not. When emails are enabled for Einstein Activity Capture, each user must accept the terms of service. The default value is false. This field is available only if you use a user-level authentication method. In connection report CSV files downloaded from Einstein Activity Capture Status & Metrics, this field is labeled User Auth Terms of Service Accepted."
    },
    "RecommendedActionDescription": {
      "type": "string",
      "properties": "Filter, Nillable, Sort",
      "description": "Recommended action to take when the user’s ConnectivityStatus is NEEDSATTENTION. Available in API version 58.0 and later."
    },
    "RecommendedActionTitle": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "Reason for the user's ConnectivityStatus when the status is NEEDSATTENTION. Available in API version 58.0 and later."
    },
    "UserId": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "ID of the user."
    },
    "UserName": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The username of the Einstein Activity Capture user."
    },
    "UserOnboardingStatus": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The initial sync status when the user connects Salesforce with their external email account and syncs data for the first time. This field is available in API version 59.0 and later. Possible values are: NOT_STARTED IN_PROGRESS NOT_CONFIGURED COMPLETE FAILED"
    }
  },
  "special_access_rules": "To access this object, enable Einstein Activity Capture in your org.\n\nTo access this object, enable Einstein Activity\n         Capture in your org.",
  "field_reference": {
    "ConfigurationName": {
      "field_label": "Configuration Name",
      "type": "string",
      "length": "18"
    },
    "ConnectivityStatus": {
      "field_label": "Connection Status",
      "type": "picklist",
      "length": "255"
    },
    "ContactsSynced": {
      "field_label": "Number of contacts synced",
      "type": "int",
      "digits": "9"
    },
    "EmailAddress": {
      "field_label": "Email Address",
      "type": "string",
      "length": "18"
    },
    "EventsSynced": {
      "field_label": "Number of events synced",
      "type": "int",
      "digits": "9"
    },
    "ExternalId": {
      "field_label": "External Id",
      "type": "string",
      "length": "255"
    },
    "GlobalOauthTermsState": {
      "field_label": "GlobalOauth Terms State",
      "type": "picklist",
      "length": "255"
    },
    "Id": {
      "field_label": "ActivityUsrConnectionStatus Id",
      "type": "id",
      "length": "18"
    },
    "IsTermsOfServiceAccepted": {
      "field_label": "Is Terms Of Service Accepted",
      "type": "boolean"
    },
    "RecommendedActionDescription": {
      "field_label": "Recommended Action Description",
      "type": "string",
      "length": "755"
    },
    "RecommendedActionTitle": {
      "field_label": "Recommended Action Title",
      "type": "string",
      "length": "255"
    },
    "UserId": {
      "field_label": "User Id",
      "type": "string",
      "length": "18"
    },
    "UserName": {
      "field_label": "User Name",
      "type": "string",
      "length": "18"
    },
    "UserOnboardingStatus": {
      "field_label": "User Onboarding Status",
      "type": "string",
      "length": "18"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "length",
    "digits"
  ]
}