REST Resource: projects.locations.sfdcInstances

Resource: SfdcInstance

The SfdcInstance resource use to hold channels and connection config data.

JSON representation
{
  "name": string,
  "displayName": string,
  "description": string,
  "sfdcOrgId": string,
  "authConfigId": [
    string
  ],
  "createTime": string,
  "updateTime": string,
  "deleteTime": string,
  "serviceAuthority": string
}
Fields
name

string

Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}.

displayName

string

User selected unique name/alias to easily reference an instance.

description

string

A description of the sfdc instance.

sfdcOrgId

string

The SFDC Org id. This is defined in salesforce.

authConfigId[]

string

A list of AuthConfigs that can be tried to open the channel to SFDC

createTime

string (Timestamp format)

Output only. Time when the instance is created

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Output only. Time when the instance was last updated

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

deleteTime

string (Timestamp format)

Output only. Time when the instance was deleted. Empty if not deleted.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

serviceAuthority

string

URL used for API calls after authentication (the login authority is configured within the referenced AuthConfig).

Methods

create

Creates an sfdc instance record.

delete

Deletes an sfdc instance.

get

Gets an sfdc instance.

list

Lists all sfdc instances that match the filter.

patch

Updates an sfdc instance.