2026-10-01
▼ ▲ integrations.connectorPlatformRegions.enumerate
Path : v1/connectorPlatformRegions:enumerate
Flat Path : v1/connectorPlatformRegions:enumerate
HTTP Method : GET
Description : Enumerates the regions for which Connector Platform is provisioned.
▼ ▲ integrations.projects.getClientmetadata
Path : v1/{+parent}/clientmetadata
HTTP Method : GET
Flat Path : v1/projects/{projectsId}/clientmetadata
Description : Gets the metadata info for the requested client
Parameter Order : parent
Parameters :
parent
Type : string
Pattern : ^projects/[^/]+$
Location : path
Description : Required. Required: The ID of the GCP Project to be provisioned.
Required : Yes
▼ ▲ integrations.projects.locations.sfdcInstances.patch
HTTP Method : PATCH
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates an sfdc instance. Updates the sfdc instance in spanner. Returns the sfdc instance.
Parameter Order : name
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}
Path : v1/{+name}
Parameters :
updateMask
Description : Field mask specifying the fields in the above SfdcInstance that have been modified and need to be updated.
Location : query
Type : string
Format : google-fieldmask
name
Pattern : ^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+$
Description : Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}.
Location : path
Type : string
Required : Yes
▼ ▲ integrations.projects.locations.sfdcInstances.create
HTTP Method : POST
Path : v1/{+parent}/sfdcInstances
Description : Creates an sfdc instance record. Store the sfdc instance in Spanner. Returns the sfdc instance.
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances
Parameter Order : parent
Parameters :
parent
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
Required : Yes
Description : Required. "projects/{project}/locations/{location}" format.
Type : string
▼ ▲ integrations.projects.locations.sfdcInstances.delete
Description : Deletes an sfdc instance.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}
Parameter Order : name
HTTP Method : DELETE
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+$
Type : string
Description : Required. The name that is associated with the SfdcInstance.
Required : Yes
Location : path
Path : v1/{+name}
▼ ▲ integrations.projects.locations.sfdcInstances.list
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances
HTTP Method : GET
Path : v1/{+parent}/sfdcInstances
Parameters :
readMask
Format : google-fieldmask
Location : query
Description : The mask which specifies fields that need to be returned in the SfdcInstance's response.
Type : string
pageToken
Location : query
Type : string
Description : The token returned in the previous response.
filter
Description : Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/list-filters.
Location : query
Type : string
parent
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+$
Description : Required. The client, which owns this collection of SfdcInstances.
Required : Yes
Location : path
pageSize
Format : int32
Location : query
Description : The size of entries in the response. If unspecified, defaults to 100.
Type : integer
Description : Lists all sfdc instances that match the filter. Restrict to sfdc instances belonging to the current client only.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
▼ ▲ integrations.projects.locations.sfdcInstances.get
Parameters :
name
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+$
Description : Required. The name that is associated with the SfdcInstance.
Required : Yes
Parameter Order : name
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}
Path : v1/{+name}
Description : Gets an sfdc instance. If the instance doesn't exist, Code.NOT_FOUND exception will be thrown.
▼ ▲ integrations.projects.locations.sfdcInstances.sfdcChannels.list
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists all sfdc channels that match the filter. Restrict to sfdc channels belonging to the current client only.
Path : v1/{+parent}/sfdcChannels
Parameters :
pageSize
Location : query
Description : The size of entries in the response. If unspecified, defaults to 100.
Type : integer
Format : int32
pageToken
Location : query
Description : The token returned in the previous response.
Type : string
readMask
Location : query
Format : google-fieldmask
Description : The mask which specifies fields that need to be returned in the SfdcChannel's response.
Type : string
filter
Description : Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/list-filters.
Location : query
Type : string
parent
Pattern : ^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+$
Location : path
Description : Required. The client, which owns this collection of SfdcChannels.
Type : string
Required : Yes
Parameter Order : parent
HTTP Method : GET
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels
▼ ▲ integrations.projects.locations.sfdcInstances.sfdcChannels.patch
Path : v1/{+name}
Parameter Order : name
Description : Updates an sfdc channel. Updates the sfdc channel in spanner. Returns the sfdc channel.
HTTP Method : PATCH
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
updateMask
Description : Field mask specifying the fields in the above SfdcChannel that have been modified and need to be updated.
Type : string
Format : google-fieldmask
Location : query
name
Location : path
Description : Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+/sfdcChannels/[^/]+$
Type : string
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}
▼ ▲ integrations.projects.locations.sfdcInstances.sfdcChannels.create
Description : Creates an sfdc channel record. Store the sfdc channel in Spanner. Returns the sfdc channel.
Parameters :
parent
Type : string
Description : Required. "projects/{project}/locations/{location}" format.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+$
Location : path
Path : v1/{+parent}/sfdcChannels
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
▼ ▲ integrations.projects.locations.sfdcInstances.sfdcChannels.delete
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}
HTTP Method : DELETE
Parameter Order : name
Description : Deletes an sfdc channel.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}
Parameters :
name
Location : path
Description : Required. The name that is associated with the SfdcChannel.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+/sfdcChannels/[^/]+$
Type : string
▼ ▲ integrations.projects.locations.sfdcInstances.sfdcChannels.get
Path : v1/{+name}
HTTP Method : GET
Parameter Order : name
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}
Parameters :
name
Description : Required. The name that is associated with the SfdcChannel.
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+/sfdcChannels/[^/]+$
Location : path
Required : Yes
Description : Gets an sfdc channel. If the channel doesn't exist, Code.NOT_FOUND exception will be thrown.
▼ ▲ integrations.projects.locations.integrations.versions.testCases.upload
Path : v1/{+parent}/testCases:upload
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases:upload
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Description : Uploads a test case. The content can be a previously downloaded test case. Performs the same function as CreateTestCase, but accepts input in a string format, which holds the complete representation of the TestCase content.
Parameter Order : parent
Parameters :
parent
Location : path
Type : string
Description : Required. The test case to upload. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{integration_version}
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$
▼ ▲ integrations.projects.locations.integrations.versions.testCases.create
Path : v1/{+parent}/testCases
Parameter Order : parent
Parameters :
testCaseId
Location : query
Type : string
Description : Required. Required
parent
Required : Yes
Type : string
Location : path
Description : Required. The parent resource where this test case will be created. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{integration_version}
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a new test case
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases
HTTP Method : POST
▼ ▲ integrations.projects.locations.integrations.versions.testCases.takeoverEditLock
Parameters :
name
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+/testCases/[^/]+$
Required : Yes
Description : Required. The ID of test case to takeover edit lock. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{integration_version}/testCases/{test_case_id}
Path : v1/{+name}:takeoverEditLock
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases/{testCasesId}:takeoverEditLock
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
HTTP Method : POST
Description : Clear the lock fields and assign them to current user
▼ ▲ integrations.projects.locations.integrations.versions.testCases.delete
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases/{testCasesId}
Parameters :
name
Required : Yes
Description : Required. ID for the test case to be deleted
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+/testCases/[^/]+$
Description : Deletes a test case
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : DELETE
Parameter Order : name
Path : v1/{+name}
▼ ▲ integrations.projects.locations.integrations.versions.testCases.get
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases/{testCasesId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+/testCases/[^/]+$
Required : Yes
Description : Required. The ID of the test case to retrieve
Type : string
Location : path
Path : v1/{+name}
Description : Get a test case
HTTP Method : GET
▼ ▲ integrations.projects.locations.integrations.versions.testCases.list
Parameters :
readMask
Format : google-fieldmask
Location : query
Type : string
Description : Optional. The mask which specifies fields that need to be returned in the TestCases's response.
filter
Description : Optional. Standard filter field. Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/list-filters.
Location : query
Type : string
orderBy
Type : string
Description : Optional. The results would be returned in order specified here. Currently supported sort keys are: Descending sort order for "last_modified_time", "created_time". Ascending sort order for "name".
Location : query
pageToken
Description : Optional. A page token, received from a previous `ListTestCases` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTestCases` must match the call that provided the page token.
Location : query
Type : string
parent
Location : path
Type : string
Description : Required. The parent resource where this TestCase was created.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$
pageSize
Format : int32
Description : Optional. The maximum number of test cases to return. The service may return fewer than this value. If unspecified, at most 100 test cases will be returned.
Location : query
Type : integer
Parameter Order : parent
Path : v1/{+parent}/testCases
Description : Lists all the test cases that satisfy the filters.
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases
▼ ▲ integrations.projects.locations.integrations.versions.testCases.executeTest
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Path : v1/{+testCaseName}:executeTest
Description : Executes functional test
Parameters :
testCaseName
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+/testCases/[^/]+$
Description : Required. Test case resource name
Type : string
Location : path
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases/{testCasesId}:executeTest
Parameter Order : testCaseName
▼ ▲ integrations.projects.locations.integrations.versions.testCases.patch
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases/{testCasesId}
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : PATCH
Parameter Order : name
Path : v1/{+name}
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+/testCases/[^/]+$
Required : Yes
Description : Output only. Auto-generated primary key.
Type : string
Location : path
updateMask
Location : query
Type : string
Description : Optional. Field mask specifying the fields in the above integration that have been modified and need to be updated.
Format : google-fieldmask
Description : Updates a test case
▼ ▲ integrations.projects.locations.integrations.versions.testCases.download
Parameters :
fileFormat
Enum :
Type : string
Enum Descriptions :
Description : File format for download request.
Location : query
name
Type : string
Required : Yes
Description : Required. The test case to download. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{integration_version}/testCases/{test_case_id}
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+/testCases/[^/]+$
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Downloads a test case. Retrieves the `TestCase` for a given `test_case_id` and returns the response as a string.
Parameter Order : name
HTTP Method : GET
Path : v1/{+name}:download
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases/{testCasesId}:download
▼ ▲ integrations.projects.locations.integrations.versions.testCases.execute
Description : Executes all test cases in an integration version.
Parameter Order : parent
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases:execute
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
parent
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$
Description : Required. The parent resource whose test cases are executed. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{integration_version}
Required : Yes
Type : string
Location : path
Path : v1/{+parent}/testCases:execute
▼ ▲ integrations.projects.locations.integrations.versions.delete
Description : Soft-deletes the integration. Changes the status of the integration to ARCHIVED. If the integration being ARCHIVED is tagged as "HEAD", the tag is removed from this snapshot and set to the previous non-ARCHIVED snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. This RPC throws an exception if the version being deleted is DRAFT, and if the `locked_by` user is not the same as the user performing the Delete. Audit fields updated include last_modified_timestamp, last_modified_by. Any existing lock is released when Deleting a integration. Currently, there is no undelete mechanism.
HTTP Method : DELETE
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$
Required : Yes
Type : string
Location : path
Description : Required. The version to delete. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Parameter Order : name
▼ ▲ integrations.projects.locations.integrations.versions.list
Parameter Order : parent
Parameters :
filter
Location : query
Type : string
Description : Filter on fields of IntegrationVersion. Fields can be compared with literal values by use of ":" (containment), "=" (equality), ">" (greater), "<" (less than), >=" (greater than or equal to), "<=" (less than or equal to), and "!=" (inequality) operators. Negation, conjunction, and disjunction are written using NOT, AND, and OR keywords. For example, organization_id=\"1\" AND state=ACTIVE AND description:"test". Filtering cannot be performed on repeated fields like `task_config`.
pageSize
Description : The maximum number of versions to return. The service may return fewer than this value. If unspecified, at most 50 versions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Location : query
Type : integer
Format : int32
fieldMask
Format : google-fieldmask
Description : The field mask which specifies the particular data to be returned.
Location : query
Type : string
orderBy
Type : string
Description : The results would be returned in order you specified here. Currently supported sort keys are: Descending sort order for "last\_modified\_time", "created\_time", and "snapshot\_number". Ascending sort order for `name`.
Location : query
parent
Description : Required. The parent resource where this version will be created. Format: projects/{project}/locations/{location}/integrations/{integration} Specifically, when parent equals: 1. projects//locations//integrations/, Meaning: "List versions (with filter) for a particular integration". 2. projects//locations//integrations/- Meaning: "List versions (with filter) for a client within a particular region".
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+$
Type : string
Location : path
pageToken
Type : string
Location : query
Description : A page token, received from a previous `ListIntegrationVersions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIntegrationVersions` must match the call that provided the page token.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions
Description : Returns the list of all integration versions in the specified project.
HTTP Method : GET
Path : v1/{+parent}/versions
▼ ▲ integrations.projects.locations.integrations.versions.unpublish
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:unpublish
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$
Description : Required. The version to deactivate. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Required : Yes
Type : string
Location : path
Parameter Order : name
Description : Sets the status of the ACTIVE integration to SNAPSHOT with a new tag "PREVIOUSLY_PUBLISHED" after validating it. The "HEAD" and "PUBLISH_REQUESTED" tags do not change. This RPC throws an exception if the version being snapshot is not ACTIVE. Audit fields added include action, action_by, action_timestamp.
Path : v1/{+name}:unpublish
▼ ▲ integrations.projects.locations.integrations.versions.get
HTTP Method : GET
Parameter Order : name
Path : v1/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get a integration in the specified project.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}
Parameters :
name
Required : Yes
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$
Description : Required. The version to retrieve. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
▼ ▲ integrations.projects.locations.integrations.versions.download
Parameters :
fileFormat
Location : query
Type : string
Description : File format for download request.
Enum :
Enum Descriptions :
files
Enum :
Type : string
Description : Optional. Integration related file to download like Integration Json, Config variable, testcase etc.
Repeated : Yes
Location : query
Enum Descriptions :
name
Type : string
Description : Required. The version to download. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$
Location : path
Parameter Order : name
HTTP Method : GET
Path : v1/{+name}:download
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:download
Description : Downloads an integration. Retrieves the `IntegrationVersion` for a given `integration_id` and returns the response as a string.
▼ ▲ integrations.projects.locations.integrations.versions.downloadJsonPackage
Parameters :
name
Description : Required. Integration version name Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Location : path
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$
files
Enum Descriptions :
Description : Optional. Integration related file to download like Integration Version, Config variable, testcase etc.
Repeated : Yes
Location : query
Enum :
Type : string
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Downloads an Integration version package like IntegrationVersion,Integration Config etc. Retrieves the IntegrationVersion package for a given `integration_id` and returns the response as a JSON.
Path : v1/{+name}:downloadJsonPackage
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:downloadJsonPackage
HTTP Method : GET
Parameter Order : name
▼ ▲ integrations.projects.locations.integrations.versions.upload
Description : Uploads an integration. The content can be a previously downloaded integration. Performs the same function as CreateDraftIntegrationVersion, but accepts input in a string format, which holds the complete representation of the IntegrationVersion content.
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+parent}/versions:upload
HTTP Method : POST
Parameter Order : parent
Parameters :
parent
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+$
Type : string
Required : Yes
Description : Required. The version to upload. Format: projects/{project}/locations/{location}/integrations/{integration}
Location : path
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions:upload
▼ ▲ integrations.projects.locations.integrations.versions.create
Parameters :
newIntegration
Description : Set this flag to true, if draft version is to be created for a brand new integration. False, if the request is for an existing integration. For backward compatibility reasons, even if this flag is set to `false` and no existing integration is found, a new draft integration will still be created.
Type : boolean
Location : query
createSampleIntegrations
Description : Optional. Optional. Indicates if sample workflow should be created.
Type : boolean
Location : query
parent
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+$
Location : path
Type : string
Description : Required. The parent resource where this version will be created. Format: projects/{project}/locations/{location}/integrations/{integration}
Description : Create a integration with a draft version in the specified project.
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+parent}/versions
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions
HTTP Method : POST
Parameter Order : parent
▼ ▲ integrations.projects.locations.integrations.versions.patch
Description : Update a integration with a draft version in the specified project.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}
Parameters :
name
Description : Output only. Auto-generated primary key.
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$
Type : string
Required : Yes
updateMask
Format : google-fieldmask
Description : Field mask specifying the fields in the above integration that have been modified and need to be updated.
Location : query
Type : string
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Path : v1/{+name}
HTTP Method : PATCH
▼ ▲ integrations.projects.locations.integrations.versions.publish
Description : This RPC throws an exception if the integration is in ARCHIVED or ACTIVE state. This RPC throws an exception if the version being published is DRAFT, and if the `locked_by` user is not the same as the user performing the Publish. Audit fields updated include last_published_timestamp, last_published_by, last_modified_timestamp, last_modified_by. Any existing lock is on this integration is released.
Parameter Order : name
Path : v1/{+name}:publish
HTTP Method : POST
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:publish
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$
Required : Yes
Description : Required. The version to publish. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Type : string
▼ ▲ integrations.projects.locations.integrations.versions.test
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:test
HTTP Method : POST
Description : Execute the integration in draft state
Path : v1/{+name}:test
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Parameters :
name
Required : Yes
Description : Output only. Auto-generated primary key.
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$
▼ ▲ integrations.projects.locations.integrations.executions.get
Path : v1/{+name}
Parameters :
name
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/executions/[^/]+$
Type : string
Description : Required. The execution resource name. Format: projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_id}/executions/{execution_id}
Location : path
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}
Description : Get an execution in the specified project.
Parameter Order : name
▼ ▲ integrations.projects.locations.integrations.executions.replay
Parameters :
name
Location : path
Description : Required. Next ID: 6 The execution resource name. Format: projects/{gcp_project_id}/locations/{location}/integrations/{integration}/executions/{execution_id}
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/executions/[^/]+$
Parameter Order : name
Description : Re-execute an existing execution, with same request parameters and execution strategy.
HTTP Method : POST
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}:replay
Path : v1/{+name}:replay
▼ ▲ integrations.projects.locations.integrations.executions.cancel
Description : Cancellation of an execution and associated sub-executions. This will not cancel an IN_PROCESS or completed(SUCCESSFUL, FAILED or CANCELLED) executions.
HTTP Method : POST
Parameter Order : name
Path : v1/{+name}:cancel
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/executions/[^/]+$
Description : Required. The execution resource name. Format: projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_id}/executions/{execution_id}
Required : Yes
Location : path
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}:cancel
▼ ▲ integrations.projects.locations.integrations.executions.list
Description : Lists the results of all the integration executions. The response includes the same information as the [execution log](https://cloud.google.com/application-integration/docs/viewing-logs) in the Integration UI.
Parameter Order : parent
Path : v1/{+parent}/executions
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions
Parameters :
pageToken
Description : Optional. The token returned in the previous response.
Location : query
Type : string
filterParams.workflowName
Description : Workflow name.
Location : query
Type : string
truncateParams
Deprecated : Yes
Type : boolean
Location : query
Description : Optional. If true, the service will truncate the params to only keep the first 1000 characters of string params and empty the executions in order to make response smaller. Only works for UI and when the params fields are not filtered out.
readMask
Format : google-fieldmask
Description : Optional. View mask for the response data. If set, only the field specified will be returned as part of the result. If not set, all fields in Execution will be filled and returned. Supported fields: trigger_id execution_method create_time update_time execution_details execution_details.state execution_details.execution_snapshots execution_details.attempt_stats execution_details.event_execution_snapshots_size request_parameters cloud_logging_details snapshot_number replay_info
Location : query
Type : string
filter
Type : string
Location : query
Description : Optional. Standard filter field, we support filtering on following fields: workflow_name: the name of the integration. CreateTimestamp: the execution created time. event_execution_state: the state of the executions. execution_id: the id of the execution. trigger_id: the id of the trigger. parameter_type: the type of the parameters involved in the execution. All fields support for EQUALS, in additional: CreateTimestamp support for LESS_THAN, GREATER_THAN ParameterType support for HAS For example: "parameter_type" HAS \"string\" Also supports operators like AND, OR, NOT For example, trigger_id=\"id1\" AND workflow_name=\"testWorkflow\"
filterParams.parameterKey
Type : string
Location : query
Deprecated : Yes
Description : Param key. DEPRECATED. User parameter_pair_key instead.
filterParams.taskStatuses
Deprecated : Yes
Repeated : Yes
Location : query
Type : string
Description : List of possible task statuses.
filterParams.eventStatuses
Repeated : Yes
Type : string
Description : List of possible event statuses.
Location : query
filterParams.endTime
Location : query
Format : int64
Type : string
Description : End timestamp.
filterParams.startTime
Description : Start timestamp.
Type : string
Format : int64
Location : query
filterParams.parameterPairKey
Location : query
Type : string
Description : Param key in the key value pair filter.
orderBy
Type : string
Location : query
Description : Optional. The results would be returned in order you specified here. Currently supporting "create_time".
snapshotMetadataWithoutParams
Location : query
Type : boolean
Description : Optional. If true, the service will provide execution info with snapshot metadata only i.e. without event parameters.
pageSize
Type : integer
Format : int32
Location : query
Description : Optional. The size of entries in the response.
parent
Required : Yes
Type : string
Location : path
Description : Required. The parent resource name of the integration execution.
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+$
filterParams.customFilter
Description : Optional user-provided custom filter.
Type : string
Location : query
refreshAcl
Type : boolean
Description : Optional. If true, the service will use the most recent acl information to list event execution infos and renew the acl cache. Note that fetching the most recent acl is synchronous, so it will increase RPC call latency.
Location : query
filterParams.parameterValue
Deprecated : Yes
Type : string
Description : Param value. DEPRECATED. User parameter_pair_value instead.
Location : query
filterParams.parameterType
Type : string
Description : Param type.
Location : query
filterParams.parameterPairValue
Location : query
Type : string
Description : Param value in the key value pair filter.
filterParams.executionId
Location : query
Type : string
Description : Execution id.
▼ ▲ integrations.projects.locations.integrations.executions.download
Parameter Order : name
HTTP Method : GET
Description : Download the execution.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}:download
Path : v1/{+name}:download
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Required : Yes
Description : Required. The execution resource name. Format: projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_id}/executions/{execution_id}
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/executions/[^/]+$
Location : path
▼ ▲ integrations.projects.locations.integrations.executions.suspensions.resolve
Parameter Order : name
Description : * Resolves (lifts/rejects) any number of suspensions. If the integration is already running, only the status of the suspension is updated. Otherwise, the suspended integration will begin execution again.
Parameters :
name
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/executions/[^/]+/suspensions/[^/]+$
Description : Required. projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_name}/executions/{execution_name}/suspensions/{suspension_id}
Location : path
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:resolve
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}:resolve
HTTP Method : POST
▼ ▲ integrations.projects.locations.integrations.executions.suspensions.list
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+parent}/suspensions
Parameters :
filter
Type : string
Location : query
Description : Standard filter field.
pageSize
Location : query
Format : int32
Type : integer
Description : Maximum number of entries in the response.
parent
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/executions/[^/]+$
Required : Yes
Type : string
Location : path
Description : Required. projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_name}/executions/{execution_name}
orderBy
Location : query
Type : string
Description : Field name to order by.
pageToken
Type : string
Description : Token to retrieve a specific page.
Location : query
Description : * Lists suspensions associated with a specific execution. Only those with permissions to resolve the relevant suspensions will be able to view them.
Parameter Order : parent
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions
▼ ▲ integrations.projects.locations.integrations.executions.suspensions.lift
Path : v1/{+name}:lift
Parameters :
name
Location : path
Description : Required. The resource that the suspension belongs to. "projects/{project}/locations/{location}/products/{product}/integrations/{integration}/executions/{execution}/suspensions/{suspenion}" format.
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/executions/[^/]+/suspensions/[^/]+$
Description : * Lifts suspension for the Suspension task. Fetch corresponding suspension with provided suspension Id, resolve suspension, and set up suspension result for the Suspension Task.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:lift
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
▼ ▲ integrations.projects.locations.integrations.test
Description : Execute the integration in draft state
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
HTTP Method : POST
Path : v1/{+name}:test
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:test
Parameters :
name
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+$
Location : path
Description : Output only. Auto-generated primary key.
▼ ▲ integrations.projects.locations.integrations.executeEvent
Path : v1/{+name}:executeEvent
Parameters :
name
Required : Yes
Description : Required. The integration resource name. Format: projects/{gcp_project_id}/locations/{location}/integrations/{integration_id}
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+$
Location : path
Type : string
triggerId
Description : Required. Id of the integration trigger config. The trigger_id is in the format: `integration_connector_trigger/projects/{gcp_project_id}/location/{location}/connections/{connection_name}/subscriptions/{subscription_name}`.
Type : string
Location : query
Parameter Order : name
Description : Executes an integration on receiving events from Integration Connector triggers, Eventarc or CPS Trigger. Input data to integration is received in body in json format
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:executeEvent
▼ ▲ integrations.projects.locations.integrations.schedule
Parameters :
name
Required : Yes
Type : string
Description : The integration resource name.
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+$
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:schedule
Description : Schedules an integration for execution by passing the trigger id and the scheduled time in the request body.
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}:schedule
Parameter Order : name
▼ ▲ integrations.projects.locations.integrations.list
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
parent
Location : path
Description : Required. Project and location from which the integrations should be listed. Format: projects/{project}
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+$
Type : string
orderBy
Description : The results would be returned in order you specified here. Supported sort keys are: Descending sort order by "last_modified_time", "created_time", "snapshot_number". Ascending sort order by the integration name.
Type : string
Location : query
pageToken
Type : string
Location : query
Description : The page token for the resquest.
pageSize
Type : integer
Description : The page size for the resquest.
Location : query
Format : int32
filter
Description : Filter on fields of IntegrationVersion. Fields can be compared with literal values by use of ":" (containment), "=" (equality), ">" (greater), "<" (less than), >=" (greater than or equal to), "<=" (less than or equal to), and "!=" (inequality) operators. Negation, conjunction, and disjunction are written using NOT, AND, and OR keywords. For example, organization_id=\"1\" AND state=ACTIVE AND description:"test". Filtering cannot be performed on repeated fields like `task_config`.
Type : string
Location : query
Path : v1/{+parent}/integrations
Parameter Order : parent
Description : Returns the list of all integrations in the specified project.
▼ ▲ integrations.projects.locations.integrations.execute
Path : v1/{+name}:execute
Parameters :
name
Required : Yes
Type : string
Description : Required. The integration resource name.
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+$
Location : path
Description : Executes integrations synchronously by passing the trigger id in the request body. The request is not returned until the requested executions are either fulfilled or experienced an error. If the integration name is not specified (passing `-`), all of the associated integration under the given trigger_id will be executed. Otherwise only the specified integration for the given `trigger_id` is executed. This is helpful for execution the integration from UI.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:execute
HTTP Method : POST
▼ ▲ integrations.projects.locations.integrations.search
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Searches and returns the list of integrations in the specified project.
HTTP Method : GET
Path : v1/{+parent}/integrations:search
Parameter Order : parent
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations:search
Parameters :
enableNaturalLanguageQueryUnderstanding
Type : boolean
Location : query
Description : Optional. Whether to enable natural language query understanding.
parent
Type : string
Location : path
Required : Yes
Description : Required. Project and location from which the integrations should be listed. Format: projects/*/locations/*/resources/integrations
Pattern : ^projects/[^/]+/locations/[^/]+$
pageToken
Type : string
Location : query
Description : Optional. A page token, received from a previous `SearchIntegrations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchIntegrations` must match the call that provided the page token.
query
Description : Required. The user query
Type : string
Location : query
pageSize
Location : query
Format : int32
Description : Optional. The maximum number of results to return. The service may return fewer than this value. If unspecified, at most 10 results will be returned. The maximum value is 100; values above 100 will be coerced to 100.
Type : integer
filter
Description : Optional. The pre-filter to be applied to the search. This should follow the expressions defined in https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata. For example, "status:ANY("ACTIVE")" will return all the resources whose status contains the "ACTIVE".
Type : string
Location : query
▼ ▲ integrations.projects.locations.integrations.delete
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Parameters :
name
Description : Required. The location resource of the request.
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+$
Location : path
Required : Yes
Description : Delete the selected integration and all versions inside
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}
HTTP Method : DELETE
Path : v1/{+name}
▼ ▲ integrations.projects.locations.clients.provisionClientPostProcessor
Description : Perform post provisioning steps after client is provisioned.
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+parent}/clients:provisionClientPostProcessor
Parameter Order : parent
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/clients:provisionClientPostProcessor
Parameters :
parent
Required : Yes
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
Description : Required. Required: The ID of the GCP Project to be provisioned.
▼ ▲ integrations.projects.locations.clients.deprovision
Parameters :
parent
Required : Yes
Description : Required. Required: The ID of the GCP Project to be deprovisioned.
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
Parameter Order : parent
Description : Perform the deprovisioning steps to disable a user GCP project to use IP and purge all related data in a wipeout-compliant way.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/clients:deprovision
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Path : v1/{+parent}/clients:deprovision
▼ ▲ integrations.projects.locations.clients.switch
HTTP Method : POST
Description : Update client from GMEK to CMEK
Parameters :
parent
Pattern : ^projects/[^/]+/locations/[^/]+$
Type : string
Required : Yes
Description : Required. Required: The ID of the GCP Project to be provisioned.
Location : path
Parameter Order : parent
Path : v1/{+parent}/clients:switch
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/clients:switch
▼ ▲ integrations.projects.locations.clients.replace
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
Path : v1/{+parent}/clients:replace
Description : Update run-as service account for provisioned client
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/clients:replace
Parameters :
parent
Location : path
Type : string
Description : Required. Required: The ID of the GCP Project to be provisioned.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+$
▼ ▲ integrations.projects.locations.clients.toggleHttp
Path : v1/{+parent}/clients:toggleHttp
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/clients:toggleHttp
HTTP Method : POST
Description : Enable/Disable http call for provisioned client
Parameter Order : parent
Parameters :
parent
Location : path
Description : Required. Required: The ID of the GCP Project to be provisioned.
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+$
Required : Yes
▼ ▲ integrations.projects.locations.clients.changeConfig
Parameter Order : parent
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
parent
Type : string
Description : Required. Required: Format - projects/{project}/locations/{location}
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+$
Path : v1/{+parent}/clients:changeConfig
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/clients:changeConfig
Description : Updates the client customer configuration for the given project and location resource name
▼ ▲ integrations.projects.locations.clients.switchVariableMasking
Path : v1/{+parent}/clients:switchVariableMasking
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/clients:switchVariableMasking
Parameter Order : parent
Parameters :
parent
Location : path
Type : string
Required : Yes
Description : Required. Required: The ID of the GCP Project to be provisioned.
Pattern : ^projects/[^/]+/locations/[^/]+$
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Description : Update variable masking for provisioned client
▼ ▲ integrations.projects.locations.clients.provision
Parameters :
parent
Description : Required. Required: The ID of the GCP Project to be provisioned.
Required : Yes
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/clients:provision
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Parameter Order : parent
Description : Perform the provisioning steps to enable a user GCP project to use IP. If GCP project already registered on IP end via Apigee Integration, provisioning will fail.
Path : v1/{+parent}/clients:provision
▼ ▲ integrations.projects.locations.authConfigs.create
HTTP Method : POST
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authConfigs
Parameter Order : parent
Path : v1/{+parent}/authConfigs
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
clientCertificate.encryptedPrivateKey
Description : The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
Location : query
Type : string
clientCertificate.passphrase
Location : query
Type : string
Description : 'passphrase' should be left unset if private key is not encrypted. Note that 'passphrase' is not the password for web server, but an extra layer of security to protected private key.
clientCertificate.sslCertificate
Type : string
Description : The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
Location : query
parent
Pattern : ^projects/[^/]+/locations/[^/]+$
Required : Yes
Description : Required. "projects/{project}/locations/{location}" format.
Type : string
Location : path
Description : Creates an auth config record. Fetch corresponding credentials for specific auth types, e.g. access token for OAuth 2.0, JWT token for JWT. Encrypt the auth config with Cloud KMS and store the encrypted credentials in Spanner. Returns the encrypted auth config.
▼ ▲ integrations.projects.locations.authConfigs.delete
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authConfigs/{authConfigsId}
Path : v1/{+name}
Description : Deletes an auth config.
Parameters :
name
Type : string
Location : path
Description : Required. The name that is associated with the AuthConfig.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/authConfigs/[^/]+$
Parameter Order : name
HTTP Method : DELETE
▼ ▲ integrations.projects.locations.authConfigs.get
Parameters :
name
Required : Yes
Description : Required. The name that is associated with the AuthConfig.
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/authConfigs/[^/]+$
Description : Gets a complete auth config. If the auth config doesn't exist, Code.NOT_FOUND exception will be thrown. Returns the decrypted auth config.
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authConfigs/{authConfigsId}
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
▼ ▲ integrations.projects.locations.authConfigs.patch
Parameter Order : name
Parameters :
clientCertificate.sslCertificate
Type : string
Description : The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
Location : query
name
Pattern : ^projects/[^/]+/locations/[^/]+/authConfigs/[^/]+$
Type : string
Location : path
Description : Resource name of the auth config. For more information, see Manage authentication profiles. projects/{project}/locations/{location}/authConfigs/{authConfig}.
Required : Yes
clientCertificate.encryptedPrivateKey
Type : string
Description : The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
Location : query
updateMask
Description : Field mask specifying the fields in the above AuthConfig that have been modified and need to be updated.
Format : google-fieldmask
Location : query
Type : string
clientCertificate.passphrase
Description : 'passphrase' should be left unset if private key is not encrypted. Note that 'passphrase' is not the password for web server, but an extra layer of security to protected private key.
Type : string
Location : query
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authConfigs/{authConfigsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}
Description : Updates an auth config. If credential is updated, fetch the encrypted auth config from Spanner, decrypt with Cloud KMS key, update the credential fields, re-encrypt with Cloud KMS key and update the Spanner record. For other fields, directly update the Spanner record. Returns the encrypted auth config.
HTTP Method : PATCH
▼ ▲ integrations.projects.locations.authConfigs.list
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authConfigs
Description : Lists all auth configs that match the filter. Restrict to auth configs belong to the current client only.
Parameters :
parent
Required : Yes
Description : Required. The client, which owns this collection of AuthConfigs.
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
readMask
Location : query
Description : The mask which specifies fields that need to be returned in the AuthConfig's response.
Type : string
Format : google-fieldmask
filter
Type : string
Description : Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/list-filters.
Location : query
pageToken
Location : query
Description : The token returned in the previous response.
Type : string
pageSize
Type : integer
Format : int32
Description : The size of entries in the response. If unspecified, defaults to 100.
Location : query
Path : v1/{+parent}/authConfigs
HTTP Method : GET
▼ ▲ integrations.projects.locations.certificates.get
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/certificates/{certificatesId}
Parameters :
name
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/certificates/[^/]+$
Description : Required. The certificate to retrieve. Format: projects/{project}/locations/{location}/certificates/{certificate}
Required : Yes
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get a certificates in the specified project.
Parameter Order : name
HTTP Method : GET
Path : v1/{+name}
▼ ▲ integrations.projects.locations.certificates.create
Parameter Order : parent
Parameters :
parent
Pattern : ^projects/[^/]+/locations/[^/]+$
Description : Required. "projects/{project}/locations/{location}" format.
Location : path
Required : Yes
Type : string
Description : Creates a new certificate. The certificate will be registered to the trawler service and will be encrypted using cloud KMS and stored in Spanner Returns the certificate.
Path : v1/{+parent}/certificates
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/certificates
HTTP Method : POST
▼ ▲ integrations.projects.locations.certificates.delete
Path : v1/{+name}
HTTP Method : DELETE
Parameter Order : name
Description : Delete a certificate
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/certificates/{certificatesId}
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/certificates/[^/]+$
Description : Required. The name that is associated with the Certificate.
Type : string
Location : path
Required : Yes
▼ ▲ integrations.projects.locations.certificates.list
Description : List all the certificates that match the filter. Restrict to certificate of current client only.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/certificates
Parameter Order : parent
Parameters :
parent
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Description : Required. The client, which owns this collection of Certificates.
readMask
Location : query
Type : string
Format : google-fieldmask
Description : The mask which specifies fields that need to be returned in the Certificate's response.
pageToken
Location : query
Description : The token returned in the previous response.
Type : string
filter
Description : Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/list-filters.
Type : string
Location : query
pageSize
Type : integer
Location : query
Format : int32
Description : The size of entries in the response. If unspecified, defaults to 100.
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+parent}/certificates
HTTP Method : GET
▼ ▲ integrations.projects.locations.certificates.patch
Description : Updates the certificate by id. If new certificate file is updated, it will register with the trawler service, re-encrypt with cloud KMS and update the Spanner record. Other fields will directly update the Spanner record. Returns the Certificate.
HTTP Method : PATCH
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/certificates/{certificatesId}
Parameter Order : name
Path : v1/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Description : Output only. Auto generated primary key
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/certificates/[^/]+$
Type : string
Location : path
updateMask
Format : google-fieldmask
Description : Field mask specifying the fields in the above Certificate that have been modified and need to be updated.
Location : query
Type : string
▼ ▲ integrations.projects.locations.templates.patch
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Description : Updates the template by given id.
Parameters :
name
Description : Identifier. Resource name of the template.
Pattern : ^projects/[^/]+/locations/[^/]+/templates/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Required. Field mask specifying the fields in the above template that have been modified and must be updated.
Type : string
Location : query
Format : google-fieldmask
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}
HTTP Method : PATCH
▼ ▲ integrations.projects.locations.templates.use
Parameter Order : name
HTTP Method : POST
Path : v1/{+name}:use
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:use
Description : Use the template to create integration. This api would keep track of usage_count and last_used_time. PERMISSION_DENIED would be thrown if template is not accessible by client.
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/templates/[^/]+$
Description : Required. The name that is associated with the Template.
Required : Yes
Location : path
Type : string
▼ ▲ integrations.projects.locations.templates.import
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/templates/[^/]+$
Description : Required. The name that is associated with the Template.
Type : string
Required : Yes
Location : path
Path : v1/{+name}:import
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:import
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
HTTP Method : POST
Description : Import the template to an existing integration. This api would keep track of usage_count and last_used_time. PERMISSION_DENIED would be thrown if template is not accessible by client.
▼ ▲ integrations.projects.locations.templates.delete
Description : Deletes a template
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}
Parameters :
name
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/templates/[^/]+$
Location : path
Description : Required. The name that is associated with the Template.
Required : Yes
Parameter Order : name
Path : v1/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : DELETE
▼ ▲ integrations.projects.locations.templates.get
Parameters :
name
Required : Yes
Description : Required. The template to retrieve. Format: projects/{project}/locations/{location}/templates/{template}
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/templates/[^/]+$
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}
Description : Get a template in the specified project.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
HTTP Method : GET
Path : v1/{+name}
▼ ▲ integrations.projects.locations.templates.list
Path : v1/{+parent}/templates
Parameters :
pageSize
Format : int32
Type : integer
Description : Optional. The size of the response entries. If unspecified, defaults to 100. The maximum value is 1000; values above 1000 will be coerced to 1000.
Location : query
pageToken
Type : string
Description : Optional. The token returned in the previous response.
Location : query
orderBy
Description : Optional. The results would be returned in the order you specified here.
Location : query
Type : string
parent
Required : Yes
Type : string
Description : Required. The client, which owns this collection of Templates.
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
filter
Type : string
Description : Optional. Standard filter field to filter templates. client_id filter won't be supported and will restrict to templates belonging to the current client only. Return all templates of the current client if the filter is empty. Also supports operators like AND, OR, NOT For example, "status=\"ACTIVE\"
Location : query
readMask
Location : query
Description : Optional. The mask which specifies fields that need to be returned in the template's response.
Type : string
Format : google-fieldmask
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/templates
Parameter Order : parent
Description : Lists all templates matching the filter.
HTTP Method : GET
▼ ▲ integrations.projects.locations.templates.unshare
Description : Unshare a template from given clients. Owner of the template can unshare template with clients. Shared client can only unshare the template from itself. PERMISSION_DENIED would be thrown if request is not from owner or for unsharing itself.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:unshare
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}:unshare
Parameters :
name
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/templates/[^/]+$
Location : path
Description : Required. The name that is associated with the Template.
Parameter Order : name
▼ ▲ integrations.projects.locations.templates.search
Parameters :
parent
Required : Yes
Type : string
Location : path
Description : Required. The client, which owns this collection of Templates.
Pattern : ^projects/[^/]+/locations/[^/]+$
orderBy
Description : Optional. The results would be returned in the order you specified here.
Type : string
Location : query
filter
Description : Optional. Standard filter field to filter templates. client_id filter won't be supported and will restrict to templates belonging to the current client only. Return all templates of the current client if the filter is empty. Also supports operators like AND, OR, NOT For example, "status=\"ACTIVE\"
Type : string
Location : query
readMask
Location : query
Type : string
Format : google-fieldmask
Description : Optional. The mask which specifies fields that need to be returned in the template's response.
pageToken
Type : string
Location : query
Description : Optional. The token returned in the previous response.
pageSize
Format : int32
Type : integer
Description : Optional. The size of the response entries. If unspecified, defaults to 100. The maximum value is 1000; values above 1000 will be coerced to 1000.
Location : query
enableNaturalLanguageQueryUnderstanding
Type : boolean
Location : query
Description : Optional. Whether to enable natural language query understanding.
query
Type : string
Description : Optional. The search query that will be passed to Vertex search service.
Location : query
Path : v1/{+parent}/templates:search
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/templates:search
Description : Search templates based on user query and filters. This api would query the templates and return a list of templates based on the user filter.
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
▼ ▲ integrations.projects.locations.templates.download
Description : Downloads a template. Retrieves the `Template` and returns the response as a string.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/templates/[^/]+$
Required : Yes
Type : string
Description : Required. The template to download. Format: projects/{project}/locations/{location}/template/{template_id}
Location : path
fileFormat
Type : string
Enum :
Location : query
Description : Required. File format for download request.
Enum Descriptions :
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:download
Path : v1/{+name}:download
HTTP Method : GET
▼ ▲ integrations.projects.locations.templates.create
Path : v1/{+parent}/templates
Parameter Order : parent
HTTP Method : POST
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/templates
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
parent
Description : Required. "projects/{project}/locations/{location}" format.
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Description : Creates a new template
▼ ▲ integrations.projects.locations.templates.upload
HTTP Method : POST
Parameter Order : parent
Path : v1/{+parent}/templates:upload
Description : Uploads a template. The content can be a previously downloaded template. Performs the same function as CreateTemplate, but accepts input in a string format, which holds the complete representation of the Template content.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/templates:upload
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
parent
Description : Required. The template to upload. Format: projects/{project}/locations/{location}
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
Type : string
▼ ▲ integrations.projects.locations.templates.share
Description : Share a template with other clients. Only the template owner can share the templates with other projects. PERMISSION_DENIED would be thrown if the request is not from the owner.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:share
Parameters :
name
Location : path
Required : Yes
Type : string
Description : Required. The name that is associated with the Template.
Pattern : ^projects/[^/]+/locations/[^/]+/templates/[^/]+$
HTTP Method : POST
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}:share
▼ ▲ integrations.projects.locations.cloudFunctions.create
Path : v1/{+parent}/cloudFunctions
Description : Creates a cloud function project.
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/cloudFunctions
Parameters :
parent
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+$
Type : string
Description : Required. The project that the executed integration belongs to.
Location : path
▼ ▲ integrations.projects.locations.connections.runtimeEntitySchemas.list
Description : Lists the JSON schemas for the properties of runtime entities, filtered by entity name.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/runtimeEntitySchemas
Parameters :
filter
Location : query
Description : Filter. Only the entity field with literal equality operator is supported.
Type : string
pageToken
Description : Page token.
Type : string
Location : query
pageSize
Location : query
Type : integer
Format : int32
Description : Page size.
parent
Description : Required. Parent resource of RuntimeEntitySchema. Format: projects/{project}/locations/{location}/connections/{connection}
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/connections/[^/]+$
Type : string
Parameter Order : parent
Path : v1/{+parent}/runtimeEntitySchemas
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
▼ ▲ integrations.projects.locations.connections.runtimeActionSchemas.list
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists the JSON schemas for the inputs and outputs of actions, filtered by action name.
Path : v1/{+parent}/runtimeActionSchemas
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/runtimeActionSchemas
HTTP Method : GET
Parameters :
pageSize
Description : Page size.
Type : integer
Format : int32
Location : query
parent
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/connections/[^/]+$
Type : string
Description : Required. Parent resource of RuntimeActionSchema. Format: projects/{project}/locations/{location}/connections/{connection}
Location : path
pageToken
Location : query
Description : Page token.
Type : string
filter
Location : query
Type : string
Description : Filter. Only the action field with literal equality operator is supported.
Parameter Order : parent
▼ ▲ integrations.projects.locations.connections.list
HTTP Method : GET
Parameter Order : parent
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/connections
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+parent}/connections
Description : Lists Connections in a given project and location.
Parameters :
filter
Location : query
Type : string
Description : Filter.
parent
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+$
Description : Required. Parent resource of the Connection, of the form: `projects/*/locations/*`
Location : path
pageToken
Description : Page token.
Location : query
Type : string
orderBy
Description : Order by parameters.
Location : query
Type : string
pageSize
Type : integer
Description : Page size.
Location : query
Format : int32
▼ ▲ integrations.projects.locations.connections.getConnectionSchemaMetadata
HTTP Method : GET
Parameter Order : name
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/connectionSchemaMetadata
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/connections/[^/]+/connectionSchemaMetadata$
Required : Yes
Description : Required. ConnectionSchemaMetadata name. Format: projects/{project}/locations/{location}/connections/{connection}/connectionSchemaMetadata
Location : path
Path : v1/{+name}
Description : Lists the available entities and actions associated with a Connection.
▼ ▲ integrations.projects.locations.products.sfdcInstances.patch
Parameters :
name
Description : Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}.
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Type : string
Description : Field mask specifying the fields in the above SfdcInstance that have been modified and need to be updated.
Format : google-fieldmask
Location : query
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}
Description : Updates an sfdc instance. Updates the sfdc instance in spanner. Returns the sfdc instance.
Path : v1/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : PATCH
Parameter Order : name
▼ ▲ integrations.projects.locations.products.sfdcInstances.get
HTTP Method : GET
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+$
Type : string
Required : Yes
Location : path
Description : Required. The name that is associated with the SfdcInstance.
Parameter Order : name
Description : Gets an sfdc instance. If the instance doesn't exist, Code.NOT_FOUND exception will be thrown.
▼ ▲ integrations.projects.locations.products.sfdcInstances.list
Parameters :
pageSize
Description : The size of entries in the response. If unspecified, defaults to 100.
Format : int32
Type : integer
Location : query
pageToken
Description : The token returned in the previous response.
Location : query
Type : string
filter
Description : Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/list-filters.
Location : query
Type : string
readMask
Description : The mask which specifies fields that need to be returned in the SfdcInstance's response.
Location : query
Format : google-fieldmask
Type : string
parent
Description : Required. The client, which owns this collection of SfdcInstances.
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+$
Required : Yes
Type : string
Location : path
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances
Path : v1/{+parent}/sfdcInstances
Parameter Order : parent
HTTP Method : GET
Description : Lists all sfdc instances that match the filter. Restrict to sfdc instances belonging to the current client only.
▼ ▲ integrations.projects.locations.products.sfdcInstances.create
Parameters :
parent
Description : Required. "projects/{project}/locations/{location}" format.
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+$
Location : path
Type : string
Required : Yes
Path : v1/{+parent}/sfdcInstances
Description : Creates an sfdc instance record. Store the sfdc instance in Spanner. Returns the sfdc instance.
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances
▼ ▲ integrations.projects.locations.products.sfdcInstances.delete
Parameters :
name
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+$
Description : Required. The name that is associated with the SfdcInstance.
Location : path
Type : string
Description : Deletes an sfdc instance.
Parameter Order : name
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : DELETE
▼ ▲ integrations.projects.locations.products.sfdcInstances.sfdcChannels.patch
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : PATCH
Description : Updates an sfdc channel. Updates the sfdc channel in spanner. Returns the sfdc channel.
Parameter Order : name
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}
Parameters :
name
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+/sfdcChannels/[^/]+$
Description : Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}.
Location : path
updateMask
Format : google-fieldmask
Location : query
Type : string
Description : Field mask specifying the fields in the above SfdcChannel that have been modified and need to be updated.
Path : v1/{+name}
▼ ▲ integrations.projects.locations.products.sfdcInstances.sfdcChannels.list
Path : v1/{+parent}/sfdcChannels
Parameter Order : parent
HTTP Method : GET
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels
Description : Lists all sfdc channels that match the filter. Restrict to sfdc channels belonging to the current client only.
Parameters :
filter
Description : Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/list-filters.
Type : string
Location : query
readMask
Format : google-fieldmask
Type : string
Description : The mask which specifies fields that need to be returned in the SfdcChannel's response.
Location : query
parent
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+$
Required : Yes
Type : string
Description : Required. The client, which owns this collection of SfdcChannels.
Location : path
pageSize
Description : The size of entries in the response. If unspecified, defaults to 100.
Format : int32
Type : integer
Location : query
pageToken
Location : query
Description : The token returned in the previous response.
Type : string
▼ ▲ integrations.projects.locations.products.sfdcInstances.sfdcChannels.get
Parameters :
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+/sfdcChannels/[^/]+$
Type : string
Description : Required. The name that is associated with the SfdcChannel.
Required : Yes
Description : Gets an sfdc channel. If the channel doesn't exist, Code.NOT_FOUND exception will be thrown.
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}
HTTP Method : GET
Path : v1/{+name}
Parameter Order : name
▼ ▲ integrations.projects.locations.products.sfdcInstances.sfdcChannels.create
HTTP Method : POST
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels
Description : Creates an sfdc channel record. Store the sfdc channel in Spanner. Returns the sfdc channel.
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
parent
Required : Yes
Description : Required. "projects/{project}/locations/{location}" format.
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+$
Type : string
Location : path
Path : v1/{+parent}/sfdcChannels
▼ ▲ integrations.projects.locations.products.sfdcInstances.sfdcChannels.delete
Description : Deletes an sfdc channel.
Parameters :
name
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+/sfdcChannels/[^/]+$
Description : Required. The name that is associated with the SfdcChannel.
Required : Yes
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}
HTTP Method : DELETE
▼ ▲ integrations.projects.locations.products.certificates.create
Description : Creates a new certificate. The certificate will be registered to the trawler service and will be encrypted using cloud KMS and stored in Spanner Returns the certificate.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Path : v1/{+parent}/certificates
Parameters :
parent
Required : Yes
Type : string
Description : Required. "projects/{project}/locations/{location}" format.
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+$
Location : path
Parameter Order : parent
▼ ▲ integrations.projects.locations.products.certificates.delete
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates/{certificatesId}
HTTP Method : DELETE
Path : v1/{+name}
Parameter Order : name
Parameters :
name
Location : path
Type : string
Description : Required. The name that is associated with the Certificate.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/certificates/[^/]+$
Description : Delete a certificate
▼ ▲ integrations.projects.locations.products.certificates.get
Description : Get a certificates in the specified project.
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates/{certificatesId}
Parameters :
name
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/certificates/[^/]+$
Location : path
Type : string
Description : Required. The certificate to retrieve. Format: projects/{project}/locations/{location}/certificates/{certificate}
Path : v1/{+name}
Parameter Order : name
▼ ▲ integrations.projects.locations.products.certificates.patch
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Path : v1/{+name}
Parameters :
updateMask
Type : string
Description : Field mask specifying the fields in the above Certificate that have been modified and need to be updated.
Format : google-fieldmask
Location : query
name
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/certificates/[^/]+$
Description : Output only. Auto generated primary key
Location : path
Type : string
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates/{certificatesId}
HTTP Method : PATCH
Description : Updates the certificate by id. If new certificate file is updated, it will register with the trawler service, re-encrypt with cloud KMS and update the Spanner record. Other fields will directly update the Spanner record. Returns the Certificate.
▼ ▲ integrations.projects.locations.products.certificates.list
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
pageSize
Description : The size of entries in the response. If unspecified, defaults to 100.
Format : int32
Location : query
Type : integer
filter
Type : string
Description : Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/list-filters.
Location : query
parent
Location : path
Description : Required. The client, which owns this collection of Certificates.
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+$
Required : Yes
readMask
Format : google-fieldmask
Location : query
Description : The mask which specifies fields that need to be returned in the Certificate's response.
Type : string
pageToken
Type : string
Description : The token returned in the previous response.
Location : query
Path : v1/{+parent}/certificates
Parameter Order : parent
Description : List all the certificates that match the filter. Restrict to certificate of current client only.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates
HTTP Method : GET
▼ ▲ integrations.projects.locations.products.authConfigs.patch
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/authConfigs/{authConfigsId}
HTTP Method : PATCH
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
clientCertificate.sslCertificate
Type : string
Description : The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
Location : query
clientCertificate.passphrase
Type : string
Location : query
Description : 'passphrase' should be left unset if private key is not encrypted. Note that 'passphrase' is not the password for web server, but an extra layer of security to protected private key.
updateMask
Format : google-fieldmask
Type : string
Description : Field mask specifying the fields in the above AuthConfig that have been modified and need to be updated.
Location : query
clientCertificate.encryptedPrivateKey
Type : string
Description : The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
Location : query
name
Description : Resource name of the auth config. For more information, see Manage authentication profiles. projects/{project}/locations/{location}/authConfigs/{authConfig}.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/authConfigs/[^/]+$
Type : string
Location : path
Path : v1/{+name}
Description : Updates an auth config. If credential is updated, fetch the encrypted auth config from Spanner, decrypt with Cloud KMS key, update the credential fields, re-encrypt with Cloud KMS key and update the Spanner record. For other fields, directly update the Spanner record. Returns the encrypted auth config.
Parameter Order : name
▼ ▲ integrations.projects.locations.products.authConfigs.list
Description : Lists all auth configs that match the filter. Restrict to auth configs belong to the current client only.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/authConfigs
HTTP Method : GET
Path : v1/{+parent}/authConfigs
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
Parameters :
pageToken
Description : The token returned in the previous response.
Location : query
Type : string
readMask
Type : string
Description : The mask which specifies fields that need to be returned in the AuthConfig's response.
Location : query
Format : google-fieldmask
pageSize
Location : query
Description : The size of entries in the response. If unspecified, defaults to 100.
Type : integer
Format : int32
parent
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+$
Type : string
Description : Required. The client, which owns this collection of AuthConfigs.
Required : Yes
filter
Location : query
Type : string
Description : Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/list-filters.
▼ ▲ integrations.projects.locations.products.authConfigs.get
Parameters :
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/authConfigs/[^/]+$
Required : Yes
Type : string
Description : Required. The name that is associated with the AuthConfig.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/authConfigs/{authConfigsId}
Parameter Order : name
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a complete auth config. If the auth config doesn't exist, Code.NOT_FOUND exception will be thrown. Returns the decrypted auth config.
Path : v1/{+name}
▼ ▲ integrations.projects.locations.products.authConfigs.create
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/authConfigs
Parameter Order : parent
Path : v1/{+parent}/authConfigs
Description : Creates an auth config record. Fetch corresponding credentials for specific auth types, e.g. access token for OAuth 2.0, JWT token for JWT. Encrypt the auth config with Cloud KMS and store the encrypted credentials in Spanner. Returns the encrypted auth config.
Parameters :
clientCertificate.encryptedPrivateKey
Description : The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
Location : query
Type : string
parent
Type : string
Description : Required. "projects/{project}/locations/{location}" format.
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+$
Location : path
Required : Yes
clientCertificate.passphrase
Location : query
Type : string
Description : 'passphrase' should be left unset if private key is not encrypted. Note that 'passphrase' is not the password for web server, but an extra layer of security to protected private key.
clientCertificate.sslCertificate
Location : query
Description : The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
Type : string
HTTP Method : POST
▼ ▲ integrations.projects.locations.products.authConfigs.delete
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Location : path
Description : Required. The name that is associated with the AuthConfig.
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/authConfigs/[^/]+$
Parameter Order : name
Description : Deletes an auth config.
HTTP Method : DELETE
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/authConfigs/{authConfigsId}
Path : v1/{+name}
▼ ▲ integrations.projects.locations.products.integrations.test
Path : v1/{+name}:test
Parameter Order : name
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Execute the integration in draft state
Parameters :
name
Description : Output only. Auto-generated primary key.
Required : Yes
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:test
▼ ▲ integrations.projects.locations.products.integrations.list
Parameter Order : parent
Parameters :
filter
Description : Filter on fields of IntegrationVersion. Fields can be compared with literal values by use of ":" (containment), "=" (equality), ">" (greater), "<" (less than), >=" (greater than or equal to), "<=" (less than or equal to), and "!=" (inequality) operators. Negation, conjunction, and disjunction are written using NOT, AND, and OR keywords. For example, organization_id=\"1\" AND state=ACTIVE AND description:"test". Filtering cannot be performed on repeated fields like `task_config`.
Type : string
Location : query
parent
Location : path
Description : Required. Project and location from which the integrations should be listed. Format: projects/{project}
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+$
Type : string
orderBy
Type : string
Description : The results would be returned in order you specified here. Supported sort keys are: Descending sort order by "last_modified_time", "created_time", "snapshot_number". Ascending sort order by the integration name.
Location : query
pageToken
Location : query
Description : The page token for the resquest.
Type : string
pageSize
Format : int32
Location : query
Description : The page size for the resquest.
Type : integer
Description : Returns the list of all integrations in the specified project.
Path : v1/{+parent}/integrations
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations
HTTP Method : GET
▼ ▲ integrations.projects.locations.products.integrations.schedule
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
HTTP Method : POST
Description : Schedules an integration for execution by passing the trigger id and the scheduled time in the request body.
Parameters :
name
Required : Yes
Type : string
Location : path
Description : The integration resource name.
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$
Path : v1/{+name}:schedule
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:schedule
▼ ▲ integrations.projects.locations.products.integrations.execute
HTTP Method : POST
Description : Executes integrations synchronously by passing the trigger id in the request body. The request is not returned until the requested executions are either fulfilled or experienced an error. If the integration name is not specified (passing `-`), all of the associated integration under the given trigger_id will be executed. Otherwise only the specified integration for the given `trigger_id` is executed. This is helpful for execution the integration from UI.
Parameter Order : name
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:execute
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}:execute
Parameters :
name
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$
Required : Yes
Description : Required. The integration resource name.
▼ ▲ integrations.projects.locations.products.integrations.executions.suspensions.resolve
Parameters :
name
Description : Required. projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_name}/executions/{execution_name}/suspensions/{suspension_id}
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/executions/[^/]+/suspensions/[^/]+$
Location : path
Required : Yes
Parameter Order : name
Path : v1/{+name}:resolve
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:resolve
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Description : * Resolves (lifts/rejects) any number of suspensions. If the integration is already running, only the status of the suspension is updated. Otherwise, the suspended integration will begin execution again.
▼ ▲ integrations.projects.locations.products.integrations.executions.suspensions.list
Description : * Lists suspensions associated with a specific execution. Only those with permissions to resolve the relevant suspensions will be able to view them.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions
Parameters :
parent
Location : path
Type : string
Description : Required. projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_name}/executions/{execution_name}
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/executions/[^/]+$
orderBy
Location : query
Type : string
Description : Field name to order by.
filter
Description : Standard filter field.
Type : string
Location : query
pageToken
Description : Token to retrieve a specific page.
Location : query
Type : string
pageSize
Location : query
Description : Maximum number of entries in the response.
Type : integer
Format : int32
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
Path : v1/{+parent}/suspensions
HTTP Method : GET
▼ ▲ integrations.projects.locations.products.integrations.executions.suspensions.lift
Parameters :
name
Description : Required. The resource that the suspension belongs to. "projects/{project}/locations/{location}/products/{product}/integrations/{integration}/executions/{execution}/suspensions/{suspenion}" format.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/executions/[^/]+/suspensions/[^/]+$
Type : string
Location : path
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:lift
Description : * Lifts suspension for the Suspension task. Fetch corresponding suspension with provided suspension Id, resolve suspension, and set up suspension result for the Suspension Task.
Path : v1/{+name}:lift
HTTP Method : POST
▼ ▲ integrations.projects.locations.products.integrations.executions.list
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists the results of all the integration executions. The response includes the same information as the [execution log](https://cloud.google.com/application-integration/docs/viewing-logs) in the Integration UI.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions
Parameter Order : parent
Parameters :
filterParams.endTime
Format : int64
Description : End timestamp.
Location : query
Type : string
filter
Type : string
Location : query
Description : Optional. Standard filter field, we support filtering on following fields: workflow_name: the name of the integration. CreateTimestamp: the execution created time. event_execution_state: the state of the executions. execution_id: the id of the execution. trigger_id: the id of the trigger. parameter_type: the type of the parameters involved in the execution. All fields support for EQUALS, in additional: CreateTimestamp support for LESS_THAN, GREATER_THAN ParameterType support for HAS For example: "parameter_type" HAS \"string\" Also supports operators like AND, OR, NOT For example, trigger_id=\"id1\" AND workflow_name=\"testWorkflow\"
filterParams.taskStatuses
Repeated : Yes
Deprecated : Yes
Type : string
Description : List of possible task statuses.
Location : query
filterParams.parameterKey
Location : query
Deprecated : Yes
Description : Param key. DEPRECATED. User parameter_pair_key instead.
Type : string
filterParams.parameterPairKey
Location : query
Type : string
Description : Param key in the key value pair filter.
refreshAcl
Description : Optional. If true, the service will use the most recent acl information to list event execution infos and renew the acl cache. Note that fetching the most recent acl is synchronous, so it will increase RPC call latency.
Location : query
Type : boolean
snapshotMetadataWithoutParams
Type : boolean
Description : Optional. If true, the service will provide execution info with snapshot metadata only i.e. without event parameters.
Location : query
filterParams.parameterType
Type : string
Location : query
Description : Param type.
filterParams.startTime
Description : Start timestamp.
Location : query
Type : string
Format : int64
filterParams.executionId
Location : query
Type : string
Description : Execution id.
filterParams.parameterPairValue
Location : query
Description : Param value in the key value pair filter.
Type : string
filterParams.workflowName
Description : Workflow name.
Type : string
Location : query
orderBy
Type : string
Description : Optional. The results would be returned in order you specified here. Currently supporting "create_time".
Location : query
truncateParams
Description : Optional. If true, the service will truncate the params to only keep the first 1000 characters of string params and empty the executions in order to make response smaller. Only works for UI and when the params fields are not filtered out.
Deprecated : Yes
Type : boolean
Location : query
readMask
Location : query
Description : Optional. View mask for the response data. If set, only the field specified will be returned as part of the result. If not set, all fields in Execution will be filled and returned. Supported fields: trigger_id execution_method create_time update_time execution_details execution_details.state execution_details.execution_snapshots execution_details.attempt_stats execution_details.event_execution_snapshots_size request_parameters cloud_logging_details snapshot_number replay_info
Format : google-fieldmask
Type : string
pageToken
Type : string
Description : Optional. The token returned in the previous response.
Location : query
filterParams.customFilter
Location : query
Description : Optional user-provided custom filter.
Type : string
parent
Required : Yes
Description : Required. The parent resource name of the integration execution.
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$
Type : string
filterParams.eventStatuses
Repeated : Yes
Type : string
Description : List of possible event statuses.
Location : query
pageSize
Type : integer
Description : Optional. The size of entries in the response.
Location : query
Format : int32
filterParams.parameterValue
Type : string
Location : query
Deprecated : Yes
Description : Param value. DEPRECATED. User parameter_pair_value instead.
Path : v1/{+parent}/executions
▼ ▲ integrations.projects.locations.products.integrations.executions.get
HTTP Method : GET
Path : v1/{+name}
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}
Parameters :
name
Location : path
Type : string
Description : Required. The execution resource name. Format: projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_id}/executions/{execution_id}
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/executions/[^/]+$
Required : Yes
Description : Get an execution in the specified project.
▼ ▲ integrations.projects.locations.products.integrations.executions.download
HTTP Method : GET
Path : v1/{+name}:download
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/executions/[^/]+$
Required : Yes
Type : string
Location : path
Description : Required. The execution resource name. Format: projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_id}/executions/{execution_id}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}:download
Description : Download the execution.
▼ ▲ integrations.projects.locations.products.integrations.versions.delete
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}
Description : Soft-deletes the integration. Changes the status of the integration to ARCHIVED. If the integration being ARCHIVED is tagged as "HEAD", the tag is removed from this snapshot and set to the previous non-ARCHIVED snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. This RPC throws an exception if the version being deleted is DRAFT, and if the `locked_by` user is not the same as the user performing the Delete. Audit fields updated include last_modified_timestamp, last_modified_by. Any existing lock is released when Deleting a integration. Currently, there is no undelete mechanism.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$
Description : Required. The version to delete. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Location : path
Parameter Order : name
Path : v1/{+name}
HTTP Method : DELETE
▼ ▲ integrations.projects.locations.products.integrations.versions.download
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}:download
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:download
Parameters :
fileFormat
Enum Descriptions :
Description : File format for download request.
Location : query
Type : string
Enum :
name
Description : Required. The version to download. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$
Location : path
Type : string
Required : Yes
files
Enum Descriptions :
Repeated : Yes
Description : Optional. Integration related file to download like Integration Json, Config variable, testcase etc.
Enum :
Type : string
Location : query
Parameter Order : name
Description : Downloads an integration. Retrieves the `IntegrationVersion` for a given `integration_id` and returns the response as a string.
HTTP Method : GET
▼ ▲ integrations.projects.locations.products.integrations.versions.publish
Description : This RPC throws an exception if the integration is in ARCHIVED or ACTIVE state. This RPC throws an exception if the version being published is DRAFT, and if the `locked_by` user is not the same as the user performing the Publish. Audit fields updated include last_published_timestamp, last_published_by, last_modified_timestamp, last_modified_by. Any existing lock is on this integration is released.
Parameter Order : name
HTTP Method : POST
Path : v1/{+name}:publish
Parameters :
name
Description : Required. The version to publish. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$
Type : string
Location : path
Required : Yes
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:publish
▼ ▲ integrations.projects.locations.products.integrations.versions.get
HTTP Method : GET
Parameter Order : name
Parameters :
name
Type : string
Required : Yes
Location : path
Description : Required. The version to retrieve. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}
Description : Get a integration in the specified project.
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}
▼ ▲ integrations.projects.locations.products.integrations.versions.unpublish
Parameters :
name
Description : Required. The version to deactivate. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$
Location : path
Type : string
Required : Yes
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:unpublish
Description : Sets the status of the ACTIVE integration to SNAPSHOT with a new tag "PREVIOUSLY_PUBLISHED" after validating it. The "HEAD" and "PUBLISH_REQUESTED" tags do not change. This RPC throws an exception if the version being snapshot is not ACTIVE. Audit fields added include action, action_by, action_timestamp.
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}:unpublish
Parameter Order : name
▼ ▲ integrations.projects.locations.products.integrations.versions.upload
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions:upload
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
HTTP Method : POST
Description : Uploads an integration. The content can be a previously downloaded integration. Performs the same function as CreateDraftIntegrationVersion, but accepts input in a string format, which holds the complete representation of the IntegrationVersion content.
Parameters :
parent
Location : path
Description : Required. The version to upload. Format: projects/{project}/locations/{location}/integrations/{integration}
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$
Type : string
Required : Yes
Path : v1/{+parent}/versions:upload
▼ ▲ integrations.projects.locations.products.integrations.versions.create
Parameters :
parent
Description : Required. The parent resource where this version will be created. Format: projects/{project}/locations/{location}/integrations/{integration}
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$
Type : string
createSampleIntegrations
Type : boolean
Description : Optional. Optional. Indicates if sample workflow should be created.
Location : query
newIntegration
Type : boolean
Location : query
Description : Set this flag to true, if draft version is to be created for a brand new integration. False, if the request is for an existing integration. For backward compatibility reasons, even if this flag is set to `false` and no existing integration is found, a new draft integration will still be created.
Description : Create a integration with a draft version in the specified project.
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions
Path : v1/{+parent}/versions
▼ ▲ integrations.projects.locations.products.integrations.versions.list
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions
Parameters :
parent
Description : Required. The parent resource where this version will be created. Format: projects/{project}/locations/{location}/integrations/{integration} Specifically, when parent equals: 1. projects//locations//integrations/, Meaning: "List versions (with filter) for a particular integration". 2. projects//locations//integrations/- Meaning: "List versions (with filter) for a client within a particular region".
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$
Required : Yes
Type : string
Location : path
fieldMask
Description : The field mask which specifies the particular data to be returned.
Type : string
Location : query
Format : google-fieldmask
pageSize
Description : The maximum number of versions to return. The service may return fewer than this value. If unspecified, at most 50 versions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Location : query
Type : integer
Format : int32
filter
Description : Filter on fields of IntegrationVersion. Fields can be compared with literal values by use of ":" (containment), "=" (equality), ">" (greater), "<" (less than), >=" (greater than or equal to), "<=" (less than or equal to), and "!=" (inequality) operators. Negation, conjunction, and disjunction are written using NOT, AND, and OR keywords. For example, organization_id=\"1\" AND state=ACTIVE AND description:"test". Filtering cannot be performed on repeated fields like `task_config`.
Type : string
Location : query
orderBy
Description : The results would be returned in order you specified here. Currently supported sort keys are: Descending sort order for "last\_modified\_time", "created\_time", and "snapshot\_number". Ascending sort order for `name`.
Type : string
Location : query
pageToken
Description : A page token, received from a previous `ListIntegrationVersions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIntegrationVersions` must match the call that provided the page token.
Location : query
Type : string
Parameter Order : parent
Description : Returns the list of all integration versions in the specified project.
Path : v1/{+parent}/versions
▼ ▲ integrations.projects.locations.products.integrations.versions.patch
Description : Update a integration with a draft version in the specified project.
HTTP Method : PATCH
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}
Parameter Order : name
Parameters :
name
Location : path
Description : Output only. Auto-generated primary key.
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$
updateMask
Description : Field mask specifying the fields in the above integration that have been modified and need to be updated.
Location : query
Type : string
Format : google-fieldmask
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}
▼ ▲ integrations.projects.locations.products.integrations.versions.takeoverEditLock
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:takeoverEditLock
Parameter Order : integrationVersion
Description : Clears the `locked_by` and `locked_at_timestamp`in the DRAFT version of this integration. It then performs the same action as the CreateDraftIntegrationVersion (i.e., copies the DRAFT version of the integration as a SNAPSHOT and then creates a new DRAFT version with the `locked_by` set to the `user_taking_over` and the `locked_at_timestamp` set to the current timestamp). Both the `locked_by` and `user_taking_over` are notified via email about the takeover. This RPC throws an exception if the integration is not in DRAFT status or if the `locked_by` and `locked_at_timestamp` fields are not set.The TakeoverEdit lock is treated the same as an edit of the integration, and hence shares ACLs with edit. Audit fields updated include last_modified_timestamp, last_modified_by.
Parameters :
integrationVersion
Type : string
Required : Yes
Description : Required. The version to take over edit lock. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Path : v1/{+integrationVersion}:takeoverEditLock
▼ ▲ integrations.projects.locations.products.cloudFunctions.create
Parameter Order : parent
Path : v1/{+parent}/cloudFunctions
Description : Creates a cloud function project.
HTTP Method : POST
Parameters :
parent
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+$
Type : string
Required : Yes
Location : path
Description : Required. The project that the executed integration belongs to.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/cloudFunctions
▼ ▲ integrations.projects.locations.appsScriptProjects.create
HTTP Method : POST
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/appsScriptProjects
Description : Creates an Apps Script project.
Parameters :
parent
Type : string
Location : path
Required : Yes
Description : Required. The project that the executed integration belongs to.
Pattern : ^projects/[^/]+/locations/[^/]+$
Path : v1/{+parent}/appsScriptProjects
▼ ▲ integrations.projects.locations.appsScriptProjects.link
Parameters :
parent
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
Type : string
Description : Required. The project that the executed integration belongs to.
Required : Yes
Path : v1/{+parent}/appsScriptProjects:link
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/appsScriptProjects:link
Parameter Order : parent
Description : Links a existing Apps Script project.
HTTP Method : POST
▼ ▲ integrations.projects.locations.generateOpenApiSpec
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Path : v1/{+name}:generateOpenApiSpec
Description : Generate OpenAPI spec for the requested integrations and api triggers
Flat Path : v1/projects/{projectsId}/locations/{locationsId}:generateOpenApiSpec
Parameters :
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
Required : Yes
Type : string
Description : Required. Project and location from which the integrations should be fetched. Format: projects/{project}/location/{location}
Parameter Order : name
▼ ▲ integrations.projects.locations.getClients
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/clients
HTTP Method : GET
Parameter Order : parent
Path : v1/{+parent}/clients
Description : Gets the client configuration for the given project and location resource name
Parameters :
parent
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Description : Required. Required: The ID of the GCP Project to be provisioned.
▼ ▲ integrations.callback.generateToken
Path : v1/callback:generateToken
Parameters :
product
Location : query
Enum :
Type : string
Enum Descriptions :
Description : Which product sends the request
redirectUri
Location : query
Description : Redirect uri of the auth code request
Type : string
state
Location : query
Description : The auth config id for the given request
Type : string
code
Description : The auth code for the given request
Type : string
Location : query
gcpProjectId
Location : query
Type : string
Description : The gcp project id of the request
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Receives the auth code and auth config id to combine that with the client id and secret to retrieve access tokens from the token endpoint. Returns either a success or error message when it's done.
Flat Path : v1/callback:generateToken
HTTP Method : GET