2022-12-31
▼ ▲ integrations.connectorPlatformRegions.enumerate
Flat Path : v1alpha/connectorPlatformRegions:enumerate
Path : v1alpha/connectorPlatformRegions:enumerate
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Enumerates the regions for which Connector Platform is provisioned.
▼ ▲ integrations.projects.locations.products.authConfigs.list
Path : v1alpha/{+parent}/authConfigs
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/authConfigs
HTTP Method : GET
Description : Lists all auth configs that match the filter. Restrict to auth configs belong to the current client only.
Parameters :
readMask
Description : The mask which specifies fields that need to be returned in the AuthConfig's response.
Type : string
Format : google-fieldmask
Location : query
pageToken
Description : The token returned in the previous response.
Location : query
Type : string
pageSize
Description : The size of entries in the response. If unspecified, defaults to 100.
Type : integer
Location : query
Format : int32
parent
Location : path
Type : string
Description : Required. The client, which owns this collection of AuthConfigs.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+$
filter
Description : Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters.
Type : string
Location : query
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
▼ ▲ integrations.projects.locations.products.authConfigs.create
HTTP Method : POST
Parameter Order : parent
Path : v1alpha/{+parent}/authConfigs
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/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.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
clientCertificate.passphrase
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.
Location : query
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-----
Type : string
Location : query
parent
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+$
Type : string
Required : Yes
Description : Required. "projects/{project}/locations/{location}" format.
Location : path
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
▼ ▲ integrations.projects.locations.products.authConfigs.delete
Description : Deletes an auth config.
HTTP Method : DELETE
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/authConfigs/{authConfigsId}
Path : v1alpha/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Parameters :
name
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/authConfigs/[^/]+$
Description : Required. The name that is associated with the AuthConfig.
Type : string
Location : path
▼ ▲ integrations.projects.locations.products.authConfigs.get
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Parameters :
name
Location : path
Type : string
Description : Required. The name that is associated with the AuthConfig.
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/authConfigs/[^/]+$
Required : Yes
HTTP Method : GET
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 : v1alpha/{+name}
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/authConfigs/{authConfigsId}
▼ ▲ integrations.projects.locations.products.authConfigs.patch
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.
Parameters :
clientCertificate.sslCertificate
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.encryptedPrivateKey
Location : query
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-----
clientCertificate.passphrase
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.
Type : string
updateMask
Type : string
Description : Field mask specifying the fields in the above AuthConfig that have been modified and need to be updated.
Format : google-fieldmask
Location : query
name
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/authConfigs/[^/]+$
Location : path
Description : Resource name of the SFDC instance projects/{project}/locations/{location}/authConfigs/{authConfig}.
Parameter Order : name
HTTP Method : PATCH
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1alpha/{+name}
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/authConfigs/{authConfigsId}
▼ ▲ integrations.projects.locations.products.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
Path : v1alpha/{+name}
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Location : path
Description : Output only. Auto generated primary key
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/certificates/[^/]+$
Required : Yes
Type : string
updateMask
Location : query
Type : string
Description : Field mask specifying the fields in the above Certificate that have been modified and need to be updated.
Format : google-fieldmask
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates/{certificatesId}
▼ ▲ integrations.projects.locations.products.certificates.create
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1alpha/{+parent}/certificates
Parameter Order : parent
HTTP Method : POST
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 : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates
Parameters :
parent
Location : path
Description : Required. "projects/{project}/locations/{location}" format.
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+$
Type : string
Required : Yes
▼ ▲ integrations.projects.locations.products.certificates.delete
HTTP Method : DELETE
Path : v1alpha/{+name}
Parameters :
name
Required : Yes
Description : Required. The name that is associated with the Certificate.
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/certificates/[^/]+$
Type : string
Location : path
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates/{certificatesId}
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Delete a certificate
▼ ▲ integrations.projects.locations.products.certificates.get
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates/{certificatesId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1alpha/{+name}
HTTP Method : GET
Description : Get a certificates in the specified project.
Parameter Order : name
Parameters :
name
Type : string
Location : path
Description : Required. The certificate to retrieve. Format: projects/{project}/locations/{location}/certificates/{certificate}
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/certificates/[^/]+$
▼ ▲ integrations.projects.locations.products.certificates.list
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates
Parameter Order : parent
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
filter
Type : string
Location : query
Description : Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters.
pageSize
Format : int32
Location : query
Type : integer
Description : The size of entries in the response. If unspecified, defaults to 100.
pageToken
Location : query
Type : string
Description : The token returned in the previous response.
readMask
Location : query
Format : google-fieldmask
Description : The mask which specifies fields that need to be returned in the Certificate's response.
Type : string
parent
Type : string
Description : Required. The client, which owns this collection of Certificates.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+$
Location : path
Path : v1alpha/{+parent}/certificates
Description : List all the certificates that match the filter. Restrict to certificate of current client only.
▼ ▲ integrations.projects.locations.products.sfdcInstances.delete
Parameters :
name
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+$
Description : Required. The name that is associated with the SfdcInstance.
Required : Yes
Location : path
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes an sfdc instance.
HTTP Method : DELETE
Path : v1alpha/{+name}
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}
▼ ▲ integrations.projects.locations.products.sfdcInstances.create
Description : Creates an sfdc instance record. Store the sfdc instance in Spanner. Returns the sfdc instance.
HTTP Method : POST
Path : v1alpha/{+parent}/sfdcInstances
Parameter Order : parent
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
parent
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+$
Location : path
Type : string
Description : Required. "projects/{project}/locations/{location}" format.
▼ ▲ integrations.projects.locations.products.sfdcInstances.patch
Parameter Order : name
Path : v1alpha/{+name}
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}
Parameters :
updateMask
Type : string
Format : google-fieldmask
Description : Field mask specifying the fields in the above SfdcInstance that have been modified and need to be updated.
Location : query
name
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+$
Required : Yes
Description : Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}.
Description : Updates an sfdc instance. Updates the sfdc instance in spanner. Returns the sfdc instance.
HTTP Method : PATCH
▼ ▲ integrations.projects.locations.products.sfdcInstances.get
Description : Gets an sfdc instance. If the instance doesn't exist, Code.NOT_FOUND exception will be thrown.
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+$
Location : path
Type : string
Description : Required. The name that is associated with the SfdcInstance.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}
HTTP Method : GET
Path : v1alpha/{+name}
▼ ▲ integrations.projects.locations.products.sfdcInstances.list
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1alpha/{+parent}/sfdcInstances
Description : Lists all sfdc instances that match the filter. Restrict to sfdc instances belonging to the current client only.
Parameter Order : parent
Parameters :
readMask
Type : string
Format : google-fieldmask
Description : The mask which specifies fields that need to be returned in the SfdcInstance's response.
Location : query
filter
Location : query
Description : Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters.
Type : string
pageSize
Description : The size of entries in the response. If unspecified, defaults to 100.
Type : integer
Location : query
Format : int32
pageToken
Type : string
Location : query
Description : The token returned in the previous response.
parent
Required : Yes
Description : Required. The client, which owns this collection of SfdcInstances.
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+$
Type : string
Location : path
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances
HTTP Method : GET
▼ ▲ integrations.projects.locations.products.sfdcInstances.sfdcChannels.create
Parameters :
parent
Location : path
Type : string
Description : Required. "projects/{project}/locations/{location}" format.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+$
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels
HTTP Method : POST
Description : Creates an sfdc channel record. Store the sfdc channel in Spanner. Returns the sfdc channel.
Path : v1alpha/{+parent}/sfdcChannels
Parameter Order : parent
▼ ▲ integrations.projects.locations.products.sfdcInstances.sfdcChannels.delete
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}
HTTP Method : DELETE
Parameter Order : name
Path : v1alpha/{+name}
Parameters :
name
Location : path
Description : Required. The name that is associated with the SfdcChannel.
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+/sfdcChannels/[^/]+$
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes an sfdc channel.
▼ ▲ integrations.projects.locations.products.sfdcInstances.sfdcChannels.patch
Path : v1alpha/{+name}
Parameter Order : name
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}
HTTP Method : PATCH
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+/sfdcChannels/[^/]+$
Location : path
Type : string
Required : Yes
Description : Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}.
updateMask
Type : string
Format : google-fieldmask
Description : Field mask specifying the fields in the above SfdcChannel that have been modified and need to be updated.
Location : query
Description : Updates an sfdc channel. Updates the sfdc channel in spanner. Returns the sfdc channel.
▼ ▲ integrations.projects.locations.products.sfdcInstances.sfdcChannels.get
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1alpha/{+name}
Parameter Order : name
HTTP Method : GET
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}
Description : Gets an sfdc channel. If the channel doesn't exist, Code.NOT_FOUND exception will be thrown.
Parameters :
name
Description : Required. The name that is associated with the SfdcChannel.
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+/sfdcChannels/[^/]+$
Type : string
▼ ▲ integrations.projects.locations.products.sfdcInstances.sfdcChannels.list
Description : Lists all sfdc channels that match the filter. Restrict to sfdc channels belonging to the current client only.
HTTP Method : GET
Path : v1alpha/{+parent}/sfdcChannels
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels
Parameters :
pageToken
Description : The token returned in the previous response.
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
pageSize
Location : query
Description : The size of entries in the response. If unspecified, defaults to 100.
Format : int32
Type : integer
filter
Description : Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters.
Location : query
Type : string
parent
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+$
Required : Yes
Location : path
Type : string
Description : Required. The client, which owns this collection of SfdcChannels.
▼ ▲ integrations.projects.locations.products.integrations.schedule
HTTP Method : POST
Path : v1alpha/{+name}:schedule
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:schedule
Description : Schedules an integration for execution by passing the trigger id and the scheduled time in the request body.
Parameters :
name
Type : string
Description : The integration resource name.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$
Location : path
Parameter Order : name
▼ ▲ integrations.projects.locations.products.integrations.monitorexecutionstats
Description : Get execution stats
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:monitorexecutionstats
Parameters :
parent
Type : string
Description : Required. The parent resource name: {parent=projects/*/locations/*}.
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$
Parameter Order : parent
HTTP Method : POST
Path : v1alpha/{+parent}:monitorexecutionstats
▼ ▲ integrations.projects.locations.products.integrations.list
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations
Description : Returns the list of all integrations in the specified project.
Parameter Order : parent
Path : v1alpha/{+parent}/integrations
Parameters :
pageSize
Description : The page size for the resquest.
Location : query
Format : int32
Type : integer
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
pageToken
Type : string
Location : query
Description : The page token for the resquest.
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
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
▼ ▲ integrations.projects.locations.products.integrations.archiveBundle
Description : PROTECT WITH A VISIBILITY LABEL. THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. Soft-deletes the bundle.
Parameters :
name
Type : string
Required : Yes
Location : path
Description : Required. The bundle to archive. Format: projects/{project}/locations/{location}/integrations/{integration}
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1alpha/{+name}:archiveBundle
HTTP Method : POST
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:archiveBundle
Parameter Order : name
▼ ▲ integrations.projects.locations.products.integrations.execute
Parameter Order : name
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:execute
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.
Parameters :
name
Description : Required. The integration resource name.
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$
Required : Yes
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Path : v1alpha/{+name}:execute
▼ ▲ integrations.projects.locations.products.integrations.executionsnapshots.list
Path : v1alpha/{+parent}/executionsnapshots
Description : Lists the snapshots of a given integration executions. This RPC is not being used.
Parameters :
filter
Type : string
Location : query
Description : Currently supports filter by `execution_info_id` or `execution_snapshot_id`.
readMask
Format : google-fieldmask
Description : 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 event execution snapshot will be filled and returned.
Type : string
Location : query
parent
Type : string
Required : Yes
Description : Required. The parent resource name of the integration execution.
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$
Location : path
pageToken
Type : string
Description : The token used to retrieve the next page results.
Location : query
pageSize
Description : Number of entries to be returned in a page.
Location : query
Format : int32
Type : integer
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executionsnapshots
HTTP Method : GET
Parameter Order : parent
▼ ▲ integrations.projects.locations.products.integrations.versions.download
Description : Downloads an integration. Retrieves the `IntegrationVersion` for a given `integration_id` and returns the response as a string.
Parameters :
fileFormat
Enum :
Description : File format for download request.
Enum Descriptions :
Type : string
Location : query
name
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$
Location : path
Description : Required. The version to download. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Required : Yes
Type : string
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:download
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Path : v1alpha/{+name}:download
▼ ▲ integrations.projects.locations.products.integrations.versions.validate
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:validate
Path : v1alpha/{+name}:validate
Parameter Order : name
Description : Validates the given integration. If the id doesn't exist, a NotFoundException is thrown. If validation fails a CanonicalCodeException is thrown. If there was no failure an empty response is returned.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Required : Yes
Description : Required. The version to validate. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$
HTTP Method : POST
▼ ▲ integrations.projects.locations.products.integrations.versions.getBundle
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:getBundle
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Required : Yes
Description : Required. The bundle name.
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$
Type : string
Path : v1alpha/{+name}:getBundle
Description : PROTECT WITH A VISIBILITY LABEL. THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. RPC to get details of the Bundle
HTTP Method : GET
▼ ▲ integrations.projects.locations.products.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.
Parameter Order : parent
Path : v1alpha/{+parent}/versions:upload
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions:upload
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
parent
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$
Location : path
Type : string
Description : Required. The version to upload. Format: projects/{project}/locations/{location}/integrations/{integration}
▼ ▲ integrations.projects.locations.products.integrations.versions.patch
Parameters :
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
name
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$
Type : string
Location : path
Required : Yes
Description : Output only. Auto-generated primary key.
HTTP Method : PATCH
Path : v1alpha/{+name}
Description : Update a integration with a draft version in the specified project.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}
Parameter Order : name
▼ ▲ integrations.projects.locations.products.integrations.versions.takeoverEditLock
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:takeoverEditLock
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.
HTTP Method : POST
Parameter Order : integrationVersion
Path : v1alpha/{+integrationVersion}:takeoverEditLock
Parameters :
integrationVersion
Required : Yes
Location : path
Type : string
Description : Required. The version to take over edit lock. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$
▼ ▲ integrations.projects.locations.products.integrations.versions.archive
HTTP Method : POST
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 archived is DRAFT, and if the `locked_by` user is not the same as the user performing the Archive. Audit fields updated include last_modified_timestamp, last_modified_by. Any existing lock is released when Archiving a integration. Currently, there is no unarchive mechanism.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:archive
Path : v1alpha/{+name}:archive
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$
Required : Yes
Location : path
Description : Required. The version to archive. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
▼ ▲ integrations.projects.locations.products.integrations.versions.deactivate
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Type : string
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$
Description : Required. The version to deactivate. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Path : v1alpha/{+name}:deactivate
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.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:deactivate
HTTP Method : POST
Parameter Order : name
▼ ▲ integrations.projects.locations.products.integrations.versions.updateBundle
HTTP Method : PATCH
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. RPC to update the Bundle
Parameters :
name
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$
Type : string
Description : Required. Bundle name
Location : path
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:updateBundle
Parameter Order : name
Path : v1alpha/{+name}:updateBundle
▼ ▲ integrations.projects.locations.products.integrations.versions.publish
HTTP Method : POST
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.
Path : v1alpha/{+name}:publish
Parameters :
name
Description : Required. The version to publish. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Location : path
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:publish
Parameter Order : name
▼ ▲ integrations.projects.locations.products.integrations.versions.list
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions
Path : v1alpha/{+parent}/versions
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
Description : Returns the list of all integration versions in the specified project.
Parameters :
pageSize
Type : integer
Location : query
Format : int32
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.
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", "snapshot_number" Ascending sort order for "name".
Location : query
fieldMask
Type : string
Location : query
Format : google-fieldmask
Description : The field mask which specifies the particular data to be returned.
parent
Required : Yes
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$
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". 3. projects//locations/-/integrations/- Meaning: "List versions (with filter) for a client".
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`.
Location : query
Type : string
pageToken
Location : query
Type : string
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.
▼ ▲ integrations.projects.locations.products.integrations.versions.get
HTTP Method : GET
Description : Get a integration in the specified project.
Parameters :
name
Description : Required. The version to retrieve. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$
Type : string
Required : Yes
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}
Path : v1alpha/{+name}
Parameter Order : name
▼ ▲ integrations.projects.locations.products.integrations.versions.create
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
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.
parent
Required : Yes
Description : Required. The parent resource where this version will be created. Format: projects/{project}/locations/{location}/integrations/{integration}
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$
Type : string
Location : path
Path : v1alpha/{+parent}/versions
Description : Create a integration with a draft version in the specified project.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions
HTTP Method : POST
▼ ▲ integrations.projects.locations.products.integrations.executions.suspensions.lift
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/executions/[^/]+/suspensions/[^/]+$
Type : string
Required : Yes
Location : path
Description : Required. The resource that the suspension belongs to. "projects/{project}/locations/{location}/products/{product}/integrations/{integration}/executions/{execution}/suspensions/{suspenion}" format.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:lift
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1alpha/{+name}:lift
Description : * Lifts suspension for advanced suspension task. Fetch corresponding suspension with provided suspension Id, resolve suspension, and set up suspension result for the Suspension Task.
HTTP Method : POST
▼ ▲ integrations.projects.locations.products.integrations.executions.suspensions.list
Parameter Order : parent
Path : v1alpha/{+parent}/suspensions
HTTP Method : GET
Parameters :
filter
Location : query
Description : Standard filter field.
Type : string
orderBy
Description : Field name to order by.
Location : query
Type : string
pageToken
Location : query
Description : Token to retrieve a specific page.
Type : string
parent
Description : Required. projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_name}/executions/{execution_name}
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/executions/[^/]+$
Type : string
pageSize
Location : query
Description : Maximum number of entries in the response.
Format : int32
Type : integer
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions
Description : * Lists suspensions associated with a specific execution. Only those with permissions to resolve the relevant suspensions will be able to view them.
▼ ▲ integrations.projects.locations.products.integrations.executions.suspensions.resolve
Parameter Order : name
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:resolve
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.
Path : v1alpha/{+name}:resolve
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/executions/[^/]+/suspensions/[^/]+$
Description : Required. projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_name}/executions/{execution_name}/suspensions/{suspension_id}
Required : Yes
▼ ▲ integrations.projects.locations.products.integrations.executions.list
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
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.
Path : v1alpha/{+parent}/executions
HTTP Method : GET
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions
Parameters :
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
filterParams.startTime
Type : string
Format : int64
Description : Start timestamp.
Location : query
pageToken
Location : query
Type : string
Description : Optional. The token returned in the previous response.
parent
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$
Description : Required. The parent resource name of the integration execution.
Type : string
Location : path
Required : Yes
filterParams.workflowName
Type : string
Description : Workflow name.
Location : query
filterParams.parameterKey
Type : string
Location : query
Description : Param key. DEPRECATED. User parameter_pair_key instead.
readMask
Type : string
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 event execution info will be filled and returned.
Format : google-fieldmask
Location : query
filterParams.taskStatuses
Description : List of possible task statuses.
Type : string
Location : query
Repeated : Yes
filterParams.endTime
Description : End timestamp.
Location : query
Type : string
Format : int64
filterParams.parameterType
Location : query
Type : string
Description : Param type.
filterParams.eventStatuses
Type : string
Location : query
Repeated : Yes
Description : List of possible event statuses.
filter
Type : string
Location : query
Description : Optional. Standard filter field, we support filtering on all fields in EventExecutionParamIndexes table. All fields support for EQUALS, in additional: CreateTimestamp support for LESS_THAN, GREATER_THAN ParameterKey, ParameterValue, ParameterType support for HAS For example: "parameter_value" HAS \"parameter1\" Also supports operators like AND, OR, NOT For example, trigger_id=\"id1\" AND event_execution_state=\"FAILED\"
filterParams.executionId
Location : query
Type : string
Description : Execution id.
orderBy
Description : Optional. The results would be returned in order you specified here. Currently supporting "last_modified_time" and "create_time".
Location : query
Type : string
filterParams.customFilter
Location : query
Description : Optional user-provided custom filter.
Type : string
truncateParams
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.
Type : boolean
filterParams.parameterPairValue
Location : query
Description : Param value in the key value pair filter.
Type : string
filterParams.parameterValue
Type : string
Description : Param value. DEPRECATED. User parameter_pair_value instead.
Location : query
pageSize
Location : query
Format : int32
Description : Optional. The size of entries in the response.
Type : integer
filterParams.parameterPairKey
Location : query
Description : Param key in the key value pair filter.
Type : string
▼ ▲ integrations.projects.locations.products.integrations.executions.cancel
Description : Cancellation of an execution
Parameter Order : name
Path : v1alpha/{+name}:cancel
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}:cancel
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/executions/[^/]+$
Type : string
Required : Yes
Location : path
Description : Required. The execution resource name. Format: projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_id}/executions/{execution_id}
HTTP Method : POST
▼ ▲ integrations.projects.locations.products.integrations.executions.get
Parameter Order : name
HTTP Method : GET
Parameters :
name
Required : Yes
Location : path
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/[^/]+$
Type : string
Path : v1alpha/{+name}
Description : Get an execution in the specified project.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}
▼ ▲ integrations.projects.locations.products.integrationtemplates.versions.create
Parameter Order : parent
Description : Creates an IntegrationTemplateVersion.
Path : v1alpha/{+parent}/versions
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrationtemplates/{integrationtemplatesId}/versions
Parameters :
parent
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrationtemplates/[^/]+$
Location : path
Description : Required. The parent resource where this TemplateVersion will be created. Format: projects/{project}/location/{location}/product/{product}/integrationtemplates/{integrationtemplate}
Required : Yes
Type : string
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
▼ ▲ integrations.projects.locations.products.integrationtemplates.versions.get
Parameters :
name
Description : Required. The TemplateVersion to retrieve. Format: projects/{project}/locations/{location}/products/{product}/integrationtemplates/{integrationtemplate}/versions/{version}
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrationtemplates/[^/]+/versions/[^/]+$
Type : string
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrationtemplates/{integrationtemplatesId}/versions/{versionsId}
Path : v1alpha/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Parameter Order : name
Description : Returns an IntegrationTemplateVersion in the specified project.
▼ ▲ integrations.projects.locations.products.integrationtemplates.versions.list
HTTP Method : GET
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrationtemplates/{integrationtemplatesId}/versions
Parameters :
pageSize
Location : query
Type : integer
Format : int32
Description : The maximum number of IntegrationTemplateVersions 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.
pageToken
Description : A page token, received from a previous `ListIntegrationTemplateVersions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIntegrationTemplateVersions` must match the call that provided the page token.
Location : query
Type : string
parent
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrationtemplates/[^/]+$
Description : Required. Format: projects/{project}/location/{location}/product/{product}/integrationtemplates/{integrationtemplate}
Location : path
Required : Yes
filter
Description : Filter syntax: defined in the EBNF grammar.
Type : string
Location : query
Parameter Order : parent
Description : Returns the list of all IntegrationTemplateVersions in the specified project.
Path : v1alpha/{+parent}/versions
▼ ▲ integrations.projects.locations.products.createBundle
Path : v1alpha/{+parent}:createBundle
Description : PROTECT WITH A VISIBILITY LABEL. THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. Create a bundle.
Parameters :
parent
Description : Required. The location resource of the request.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+$
Location : path
Type : string
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}:createBundle
HTTP Method : POST
▼ ▲ integrations.projects.locations.products.listTaskEntities
HTTP Method : GET
Parameter Order : parent
Description : This is a UI only method and will be moved away. Returns a list of common tasks.
Path : v1alpha/{+parent}:listTaskEntities
Parameters :
parent
Location : path
Description : Required. The location resource of the request. This is not going to be used but preserve the field for future.
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+$
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}:listTaskEntities
▼ ▲ integrations.projects.locations.certificates.get
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Description : Get a certificates in the specified project.
Path : v1alpha/{+name}
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/certificates/{certificatesId}
Parameters :
name
Description : Required. The certificate to retrieve. Format: projects/{project}/locations/{location}/certificates/{certificate}
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/certificates/[^/]+$
Required : Yes
Location : path
Parameter Order : name
▼ ▲ integrations.projects.locations.sfdcInstances.delete
Parameters :
name
Type : string
Description : Required. The name that is associated with the SfdcInstance.
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+$
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}
Description : Deletes an sfdc instance.
Path : v1alpha/{+name}
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : DELETE
▼ ▲ integrations.projects.locations.sfdcInstances.get
Parameter Order : name
Parameters :
name
Required : Yes
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+$
Description : Required. The name that is associated with the SfdcInstance.
Path : v1alpha/{+name}
Description : Gets an sfdc instance. If the instance doesn't exist, Code.NOT_FOUND exception will be thrown.
HTTP Method : GET
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}
▼ ▲ integrations.projects.locations.sfdcInstances.patch
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}
Description : Updates an sfdc instance. Updates the sfdc instance in spanner. Returns the sfdc instance.
Parameter Order : name
Path : v1alpha/{+name}
HTTP Method : PATCH
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
updateMask
Type : string
Location : query
Description : Field mask specifying the fields in the above SfdcInstance that have been modified and need to be updated.
Format : google-fieldmask
name
Description : Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}.
Required : Yes
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+$
▼ ▲ integrations.projects.locations.sfdcInstances.create
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1alpha/{+parent}/sfdcInstances
Description : Creates an sfdc instance record. Store the sfdc instance in Spanner. Returns the sfdc instance.
HTTP Method : POST
Parameters :
parent
Pattern : ^projects/[^/]+/locations/[^/]+$
Description : Required. "projects/{project}/locations/{location}" format.
Required : Yes
Location : path
Type : string
Parameter Order : parent
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/sfdcInstances
▼ ▲ integrations.projects.locations.sfdcInstances.list
Parameters :
pageSize
Type : integer
Description : The size of entries in the response. If unspecified, defaults to 100.
Format : int32
Location : query
filter
Description : Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters.
Location : query
Type : string
parent
Description : Required. The client, which owns this collection of SfdcInstances.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Type : string
Required : Yes
pageToken
Location : query
Description : The token returned in the previous response.
Type : string
readMask
Format : google-fieldmask
Description : The mask which specifies fields that need to be returned in the SfdcInstance's response.
Type : string
Location : query
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists all sfdc instances that match the filter. Restrict to sfdc instances belonging to the current client only.
Path : v1alpha/{+parent}/sfdcInstances
HTTP Method : GET
Parameter Order : parent
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/sfdcInstances
▼ ▲ integrations.projects.locations.sfdcInstances.sfdcChannels.patch
Parameter Order : name
Path : v1alpha/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates an sfdc channel. Updates the sfdc channel in spanner. Returns the sfdc channel.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}
Parameters :
name
Description : Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}.
Required : Yes
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+/sfdcChannels/[^/]+$
updateMask
Location : query
Description : Field mask specifying the fields in the above SfdcChannel that have been modified and need to be updated.
Type : string
Format : google-fieldmask
HTTP Method : PATCH
▼ ▲ integrations.projects.locations.sfdcInstances.sfdcChannels.create
Parameters :
parent
Location : path
Description : Required. "projects/{project}/locations/{location}" format.
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+$
Description : Creates an sfdc channel record. Store the sfdc channel in Spanner. Returns the sfdc channel.
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Parameter Order : parent
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels
Path : v1alpha/{+parent}/sfdcChannels
▼ ▲ integrations.projects.locations.sfdcInstances.sfdcChannels.get
Parameter Order : name
Parameters :
name
Description : Required. The name that is associated with the SfdcChannel.
Pattern : ^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+/sfdcChannels/[^/]+$
Required : Yes
Location : path
Type : string
Path : v1alpha/{+name}
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}
HTTP Method : GET
Description : Gets an sfdc channel. If the channel doesn't exist, Code.NOT_FOUND exception will be thrown.
▼ ▲ integrations.projects.locations.sfdcInstances.sfdcChannels.list
Parameters :
readMask
Location : query
Type : string
Description : The mask which specifies fields that need to be returned in the SfdcChannel's response.
Format : google-fieldmask
pageSize
Type : integer
Description : The size of entries in the response. If unspecified, defaults to 100.
Location : query
Format : int32
pageToken
Type : string
Location : query
Description : The token returned in the previous response.
filter
Location : query
Type : string
Description : Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters.
parent
Description : Required. The client, which owns this collection of SfdcChannels.
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+$
Required : Yes
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1alpha/{+parent}/sfdcChannels
Description : Lists all sfdc channels that match the filter. Restrict to sfdc channels belonging to the current client only.
Parameter Order : parent
HTTP Method : GET
▼ ▲ integrations.projects.locations.sfdcInstances.sfdcChannels.delete
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Description : Deletes an sfdc channel.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}
Path : v1alpha/{+name}
HTTP Method : DELETE
Parameters :
name
Required : Yes
Location : path
Description : Required. The name that is associated with the SfdcChannel.
Pattern : ^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+/sfdcChannels/[^/]+$
Type : string
▼ ▲ integrations.projects.locations.appsScriptProjects.link
Parameters :
parent
Description : Required. The project that the executed integration belongs to.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/appsScriptProjects:link
Parameter Order : parent
Path : v1alpha/{+parent}/appsScriptProjects:link
Description : Links a existing Apps Script project.
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
▼ ▲ integrations.projects.locations.appsScriptProjects.create
Description : Creates an Apps Script project.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/appsScriptProjects
Parameters :
parent
Required : Yes
Description : Required. The project that the executed integration belongs to.
Pattern : ^projects/[^/]+/locations/[^/]+$
Type : string
Location : path
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1alpha/{+parent}/appsScriptProjects
HTTP Method : POST
▼ ▲ integrations.projects.locations.integrations.executions.list
HTTP Method : GET
Parameters :
pageSize
Format : int32
Description : Optional. The size of entries in the response.
Location : query
Type : integer
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.
Location : query
Type : boolean
filterParams.parameterKey
Type : string
Description : Param key. DEPRECATED. User parameter_pair_key instead.
Location : query
parent
Description : Required. The parent resource name of the integration execution.
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+$
Type : string
Required : Yes
filterParams.parameterPairKey
Location : query
Description : Param key in the key value pair filter.
Type : string
filterParams.parameterPairValue
Description : Param value in the key value pair filter.
Location : query
Type : string
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 event execution info will be filled and returned.
Type : string
Format : google-fieldmask
filterParams.executionId
Type : string
Location : query
Description : Execution id.
filterParams.eventStatuses
Location : query
Description : List of possible event statuses.
Repeated : Yes
Type : string
pageToken
Type : string
Description : Optional. The token returned in the previous response.
Location : query
filterParams.customFilter
Type : string
Location : query
Description : Optional user-provided custom filter.
filterParams.parameterValue
Description : Param value. DEPRECATED. User parameter_pair_value instead.
Type : string
Location : query
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
filter
Location : query
Description : Optional. Standard filter field, we support filtering on all fields in EventExecutionParamIndexes table. All fields support for EQUALS, in additional: CreateTimestamp support for LESS_THAN, GREATER_THAN ParameterKey, ParameterValue, ParameterType support for HAS For example: "parameter_value" HAS \"parameter1\" Also supports operators like AND, OR, NOT For example, trigger_id=\"id1\" AND event_execution_state=\"FAILED\"
Type : string
filterParams.workflowName
Type : string
Description : Workflow name.
Location : query
orderBy
Type : string
Description : Optional. The results would be returned in order you specified here. Currently supporting "last_modified_time" and "create_time".
Location : query
filterParams.startTime
Type : string
Description : Start timestamp.
Location : query
Format : int64
filterParams.taskStatuses
Description : List of possible task statuses.
Type : string
Location : query
Repeated : Yes
filterParams.endTime
Location : query
Type : string
Format : int64
Description : End timestamp.
filterParams.parameterType
Description : Param type.
Type : string
Location : query
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions
Path : v1alpha/{+parent}/executions
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.
▼ ▲ integrations.projects.locations.integrations.versions.list
HTTP Method : GET
Description : Returns the list of all integration versions in the specified project.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/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". 3. projects//locations/-/integrations/- Meaning: "List versions (with filter) for a client".
Type : string
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+$
pageToken
Location : query
Type : string
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.
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`.
fieldMask
Format : google-fieldmask
Description : The field mask which specifies the particular data to be returned.
Type : string
Location : query
pageSize
Location : query
Type : integer
Format : int32
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.
orderBy
Location : query
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", "snapshot_number" Ascending sort order for "name".
Type : string
Path : v1alpha/{+parent}/versions
▼ ▲ integrations.projects.locations.integrations.versions.publish
HTTP Method : POST
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.
Parameters :
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$
Type : string
Required : Yes
Description : Required. The version to publish. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Parameter Order : name
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:publish
Path : v1alpha/{+name}:publish
▼ ▲ integrations.projects.locations.integrations.versions.get
Parameters :
name
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$
Type : string
Description : Required. The version to retrieve. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Location : path
HTTP Method : GET
Description : Get a integration in the specified project.
Path : v1alpha/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}
▼ ▲ integrations.projects.locations.integrations.versions.validate
Parameter Order : name
HTTP Method : POST
Description : Validates the given integration. If the id doesn't exist, a NotFoundException is thrown. If validation fails a CanonicalCodeException is thrown. If there was no failure an empty response is returned.
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1alpha/{+name}:validate
Parameters :
name
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$
Description : Required. The version to validate. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Required : Yes
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:validate
▼ ▲ integrations.projects.locations.integrations.versions.deactivate
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:deactivate
Parameters :
name
Type : string
Required : Yes
Description : Required. The version to deactivate. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$
HTTP Method : POST
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.
Parameter Order : name
Path : v1alpha/{+name}:deactivate
▼ ▲ integrations.projects.locations.integrations.versions.takeoverEditLock
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
integrationVersion
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$
Description : Required. The version to take over edit lock. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Required : Yes
Location : path
Parameter Order : integrationVersion
HTTP Method : POST
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.
Path : v1alpha/{+integrationVersion}:takeoverEditLock
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:takeoverEditLock
▼ ▲ integrations.projects.locations.integrations.versions.patch
Description : Update a integration with a draft version in the specified project.
HTTP Method : PATCH
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$
Type : string
Description : Output only. Auto-generated primary key.
Location : path
Required : Yes
updateMask
Description : Field mask specifying the fields in the above integration that have been modified and need to be updated.
Format : google-fieldmask
Location : query
Type : string
Path : v1alpha/{+name}
▼ ▲ integrations.projects.locations.integrations.versions.create
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions
HTTP Method : POST
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
parent
Description : Required. The parent resource where this version will be created. Format: projects/{project}/locations/{location}/integrations/{integration}
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+$
Location : path
Required : Yes
Description : Create a integration with a draft version in the specified project.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
Path : v1alpha/{+parent}/versions
▼ ▲ integrations.projects.locations.integrations.versions.archive
HTTP Method : POST
Path : v1alpha/{+name}:archive
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:archive
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Required : Yes
Description : Required. The version to archive. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$
Type : string
Location : path
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 archived is DRAFT, and if the `locked_by` user is not the same as the user performing the Archive. Audit fields updated include last_modified_timestamp, last_modified_by. Any existing lock is released when Archiving a integration. Currently, there is no unarchive mechanism.
Parameter Order : name
▼ ▲ integrations.projects.locations.integrations.execute
Path : v1alpha/{+name}:execute
Parameter Order : name
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.
HTTP Method : POST
Parameters :
name
Description : Required. The integration resource name.
Location : path
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+$
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:execute
▼ ▲ integrations.projects.locations.integrations.list
HTTP Method : GET
Parameter Order : parent
Description : Returns the list of all integrations in the specified project.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
pageSize
Type : integer
Location : query
Description : The page size for the resquest.
Format : int32
pageToken
Location : query
Type : string
Description : The page token for the resquest.
orderBy
Location : query
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
parent
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Type : string
Description : Required. Project and location from which the integrations should be listed. Format: projects/{project}
Required : Yes
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
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/integrations
Path : v1alpha/{+parent}/integrations
▼ ▲ integrations.projects.locations.integrations.monitorexecutionstats
Parameter Order : parent
Description : Get execution stats
Parameters :
parent
Required : Yes
Description : Required. The parent resource name: {parent=projects/*/locations/*}.
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+$
Location : path
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1alpha/{+parent}:monitorexecutionstats
HTTP Method : POST
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:monitorexecutionstats
▼ ▲ integrations.projects.locations.integrations.schedule
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+$
Type : string
Location : path
Description : The integration resource name.
Path : v1alpha/{+name}:schedule
Description : Schedules an integration for execution by passing the trigger id and the scheduled time in the request body.
Parameter Order : name
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:schedule
HTTP Method : POST
▼ ▲ integrations.projects.locations.authConfigs.patch
Path : v1alpha/{+name}
Parameters :
name
Description : Resource name of the SFDC instance projects/{project}/locations/{location}/authConfigs/{authConfig}.
Required : Yes
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/authConfigs/[^/]+$
clientCertificate.encryptedPrivateKey
Location : query
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-----
clientCertificate.sslCertificate
Type : string
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-----
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
Description : Field mask specifying the fields in the above AuthConfig that have been modified and need to be updated.
Location : query
Format : google-fieldmask
Type : string
Scopes : https://www.googleapis.com/auth/cloud-platform
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
Parameter Order : name
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/authConfigs/{authConfigsId}
▼ ▲ integrations.projects.locations.authConfigs.list
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists all auth configs that match the filter. Restrict to auth configs belong to the current client only.
HTTP Method : GET
Parameters :
filter
Type : string
Location : query
Description : Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters.
parent
Description : Required. The client, which owns this collection of AuthConfigs.
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
readMask
Type : string
Description : The mask which specifies fields that need to be returned in the AuthConfig's response.
Format : google-fieldmask
Location : query
pageSize
Location : query
Format : int32
Type : integer
Description : The size of entries in the response. If unspecified, defaults to 100.
pageToken
Type : string
Description : The token returned in the previous response.
Location : query
Path : v1alpha/{+parent}/authConfigs
Parameter Order : parent
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/authConfigs
▼ ▲ integrations.projects.locations.authConfigs.create
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.passphrase
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.
Location : query
clientCertificate.sslCertificate
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
Description : Required. "projects/{project}/locations/{location}" format.
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
Type : string
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
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/authConfigs
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1alpha/{+parent}/authConfigs
Parameter Order : parent
▼ ▲ integrations.projects.locations.authConfigs.delete
Path : v1alpha/{+name}
Description : Deletes an auth config.
Parameters :
name
Description : Required. The name that is associated with the AuthConfig.
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/authConfigs/[^/]+$
Required : Yes
Type : string
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/authConfigs/{authConfigsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
HTTP Method : DELETE
▼ ▲ integrations.projects.locations.authConfigs.get
HTTP Method : GET
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.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/authConfigs/{authConfigsId}
Parameter Order : name
Parameters :
name
Description : Required. The name that is associated with the AuthConfig.
Pattern : ^projects/[^/]+/locations/[^/]+/authConfigs/[^/]+$
Location : path
Required : Yes
Type : string
Path : v1alpha/{+name}
▼ ▲ integrations.projects.locations.connections.list
Parameters :
pageToken
Type : string
Description : Page token.
Location : query
orderBy
Description : Order by parameters.
Type : string
Location : query
pageSize
Format : int32
Location : query
Description : Page size.
Type : integer
parent
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
Required : Yes
Type : string
Description : Required. Parent resource of the Connection, of the form: `projects/*/locations/*`
filter
Location : query
Description : Filter.
Type : string
Parameter Order : parent
Path : v1alpha/{+parent}/connections
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists Connections in a given project and location.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/connections
HTTP Method : GET
▼ ▲ integrations.projects.locations.connections.getConnectionSchemaMetadata
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists the available entities and actions associated with a Connection.
Parameter Order : name
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/connectionSchemaMetadata
HTTP Method : GET
Parameters :
name
Description : Required. ConnectionSchemaMetadata name. Format: projects/{project}/locations/{location}/connections/{connection}/connectionSchemaMetadata
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/connections/[^/]+/connectionSchemaMetadata$
Required : Yes
Type : string
Path : v1alpha/{+name}
▼ ▲ integrations.projects.locations.connections.runtimeEntitySchemas.list
Path : v1alpha/{+parent}/runtimeEntitySchemas
Parameters :
pageSize
Location : query
Description : Page size.
Format : int32
Type : integer
parent
Pattern : ^projects/[^/]+/locations/[^/]+/connections/[^/]+$
Location : path
Type : string
Description : Required. Parent resource of RuntimeEntitySchema. Format: projects/{project}/locations/{location}/connections/{connection}
Required : Yes
pageToken
Location : query
Description : Page token.
Type : string
filter
Description : Filter. Only the entity field with literal equality operator is supported.
Type : string
Location : query
Parameter Order : parent
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/runtimeEntitySchemas
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Description : Lists the JSON schemas for the properties of runtime entities, filtered by entity name.
▼ ▲ integrations.projects.locations.connections.runtimeActionSchemas.list
Parameters :
pageSize
Location : query
Description : Page size.
Type : integer
Format : int32
pageToken
Description : Page token.
Location : query
Type : string
filter
Description : Filter. Only the action field with literal equality operator is supported.
Type : string
Location : query
parent
Required : Yes
Description : Required. Parent resource of RuntimeActionSchema. Format: projects/{project}/locations/{location}/connections/{connection}
Pattern : ^projects/[^/]+/locations/[^/]+/connections/[^/]+$
Location : path
Type : string
Path : v1alpha/{+parent}/runtimeActionSchemas
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/runtimeActionSchemas
Description : Lists the JSON schemas for the inputs and outputs of actions, filtered by action name.
Parameter Order : parent
▼ ▲ integrations.projects.locations.listTaskEntities
Description : This is a UI only method and will be moved away. Returns a list of common tasks.
Path : v1alpha/{+parent}:listTaskEntities
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}:listTaskEntities
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Parameters :
parent
Description : Required. The location resource of the request. This is not going to be used but preserve the field for future.
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+$
Required : Yes
Location : path
Parameter Order : parent
▼ ▲ integrations.callback.generateToken
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1alpha/callback:generateToken
Parameters :
product
Enum :
Type : string
Location : query
Description : Which product sends the request
Enum Descriptions :
redirectUri
Type : string
Description : Redirect uri of the auth code request
Location : query
gcpProjectId
Type : string
Location : query
Description : The gcp project id of the request
state
Type : string
Description : The auth config id for the given request
Location : query
code
Description : The auth code for the given request
Type : string
Location : query
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.
HTTP Method : GET
Flat Path : v1alpha/callback:generateToken
▼ ▲ integrations.connectorPlatformRegions.enumerate
Flat Path : v1alpha/connectorPlatformRegions:enumerate
Path : v1alpha/connectorPlatformRegions:enumerate
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Enumerates the regions for which Connector Platform is provisioned.
▼ ▲ integrations.projects.locations.products.authConfigs.list
Path : v1alpha/{+parent}/authConfigs
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/authConfigs
HTTP Method : GET
Description : Lists all auth configs that match the filter. Restrict to auth configs belong to the current client only.
Parameters :
readMask
Description : The mask which specifies fields that need to be returned in the AuthConfig's response.
Type : string
Format : google-fieldmask
Location : query
pageToken
Description : The token returned in the previous response.
Location : query
Type : string
pageSize
Description : The size of entries in the response. If unspecified, defaults to 100.
Type : integer
Location : query
Format : int32
parent
Location : path
Type : string
Description : Required. The client, which owns this collection of AuthConfigs.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+$
filter
Description : Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters.
Type : string
Location : query
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
▼ ▲ integrations.projects.locations.products.authConfigs.create
HTTP Method : POST
Parameter Order : parent
Path : v1alpha/{+parent}/authConfigs
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/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.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
clientCertificate.passphrase
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.
Location : query
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-----
Type : string
Location : query
parent
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+$
Type : string
Required : Yes
Description : Required. "projects/{project}/locations/{location}" format.
Location : path
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
▼ ▲ integrations.projects.locations.products.authConfigs.delete
Description : Deletes an auth config.
HTTP Method : DELETE
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/authConfigs/{authConfigsId}
Path : v1alpha/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Parameters :
name
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/authConfigs/[^/]+$
Description : Required. The name that is associated with the AuthConfig.
Type : string
Location : path
▼ ▲ integrations.projects.locations.products.authConfigs.get
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Parameters :
name
Location : path
Type : string
Description : Required. The name that is associated with the AuthConfig.
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/authConfigs/[^/]+$
Required : Yes
HTTP Method : GET
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 : v1alpha/{+name}
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/authConfigs/{authConfigsId}
▼ ▲ integrations.projects.locations.products.authConfigs.patch
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.
Parameters :
clientCertificate.sslCertificate
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.encryptedPrivateKey
Location : query
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-----
clientCertificate.passphrase
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.
Type : string
updateMask
Type : string
Description : Field mask specifying the fields in the above AuthConfig that have been modified and need to be updated.
Format : google-fieldmask
Location : query
name
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/authConfigs/[^/]+$
Location : path
Description : Resource name of the SFDC instance projects/{project}/locations/{location}/authConfigs/{authConfig}.
Parameter Order : name
HTTP Method : PATCH
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1alpha/{+name}
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/authConfigs/{authConfigsId}
▼ ▲ integrations.projects.locations.products.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
Path : v1alpha/{+name}
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Location : path
Description : Output only. Auto generated primary key
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/certificates/[^/]+$
Required : Yes
Type : string
updateMask
Location : query
Type : string
Description : Field mask specifying the fields in the above Certificate that have been modified and need to be updated.
Format : google-fieldmask
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates/{certificatesId}
▼ ▲ integrations.projects.locations.products.certificates.create
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1alpha/{+parent}/certificates
Parameter Order : parent
HTTP Method : POST
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 : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates
Parameters :
parent
Location : path
Description : Required. "projects/{project}/locations/{location}" format.
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+$
Type : string
Required : Yes
▼ ▲ integrations.projects.locations.products.certificates.delete
HTTP Method : DELETE
Path : v1alpha/{+name}
Parameters :
name
Required : Yes
Description : Required. The name that is associated with the Certificate.
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/certificates/[^/]+$
Type : string
Location : path
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates/{certificatesId}
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Delete a certificate
▼ ▲ integrations.projects.locations.products.certificates.get
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates/{certificatesId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1alpha/{+name}
HTTP Method : GET
Description : Get a certificates in the specified project.
Parameter Order : name
Parameters :
name
Type : string
Location : path
Description : Required. The certificate to retrieve. Format: projects/{project}/locations/{location}/certificates/{certificate}
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/certificates/[^/]+$
▼ ▲ integrations.projects.locations.products.certificates.list
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates
Parameter Order : parent
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
filter
Type : string
Location : query
Description : Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters.
pageSize
Format : int32
Location : query
Type : integer
Description : The size of entries in the response. If unspecified, defaults to 100.
pageToken
Location : query
Type : string
Description : The token returned in the previous response.
readMask
Location : query
Format : google-fieldmask
Description : The mask which specifies fields that need to be returned in the Certificate's response.
Type : string
parent
Type : string
Description : Required. The client, which owns this collection of Certificates.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+$
Location : path
Path : v1alpha/{+parent}/certificates
Description : List all the certificates that match the filter. Restrict to certificate of current client only.
▼ ▲ integrations.projects.locations.products.sfdcInstances.delete
Parameters :
name
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+$
Description : Required. The name that is associated with the SfdcInstance.
Required : Yes
Location : path
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes an sfdc instance.
HTTP Method : DELETE
Path : v1alpha/{+name}
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}
▼ ▲ integrations.projects.locations.products.sfdcInstances.create
Description : Creates an sfdc instance record. Store the sfdc instance in Spanner. Returns the sfdc instance.
HTTP Method : POST
Path : v1alpha/{+parent}/sfdcInstances
Parameter Order : parent
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
parent
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+$
Location : path
Type : string
Description : Required. "projects/{project}/locations/{location}" format.
▼ ▲ integrations.projects.locations.products.sfdcInstances.patch
Parameter Order : name
Path : v1alpha/{+name}
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}
Parameters :
updateMask
Type : string
Format : google-fieldmask
Description : Field mask specifying the fields in the above SfdcInstance that have been modified and need to be updated.
Location : query
name
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+$
Required : Yes
Description : Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}.
Description : Updates an sfdc instance. Updates the sfdc instance in spanner. Returns the sfdc instance.
HTTP Method : PATCH
▼ ▲ integrations.projects.locations.products.sfdcInstances.get
Description : Gets an sfdc instance. If the instance doesn't exist, Code.NOT_FOUND exception will be thrown.
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+$
Location : path
Type : string
Description : Required. The name that is associated with the SfdcInstance.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}
HTTP Method : GET
Path : v1alpha/{+name}
▼ ▲ integrations.projects.locations.products.sfdcInstances.list
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1alpha/{+parent}/sfdcInstances
Description : Lists all sfdc instances that match the filter. Restrict to sfdc instances belonging to the current client only.
Parameter Order : parent
Parameters :
readMask
Type : string
Format : google-fieldmask
Description : The mask which specifies fields that need to be returned in the SfdcInstance's response.
Location : query
filter
Location : query
Description : Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters.
Type : string
pageSize
Description : The size of entries in the response. If unspecified, defaults to 100.
Type : integer
Location : query
Format : int32
pageToken
Type : string
Location : query
Description : The token returned in the previous response.
parent
Required : Yes
Description : Required. The client, which owns this collection of SfdcInstances.
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+$
Type : string
Location : path
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances
HTTP Method : GET
▼ ▲ integrations.projects.locations.products.sfdcInstances.sfdcChannels.create
Parameters :
parent
Location : path
Type : string
Description : Required. "projects/{project}/locations/{location}" format.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+$
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels
HTTP Method : POST
Description : Creates an sfdc channel record. Store the sfdc channel in Spanner. Returns the sfdc channel.
Path : v1alpha/{+parent}/sfdcChannels
Parameter Order : parent
▼ ▲ integrations.projects.locations.products.sfdcInstances.sfdcChannels.delete
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}
HTTP Method : DELETE
Parameter Order : name
Path : v1alpha/{+name}
Parameters :
name
Location : path
Description : Required. The name that is associated with the SfdcChannel.
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+/sfdcChannels/[^/]+$
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes an sfdc channel.
▼ ▲ integrations.projects.locations.products.sfdcInstances.sfdcChannels.patch
Path : v1alpha/{+name}
Parameter Order : name
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}
HTTP Method : PATCH
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+/sfdcChannels/[^/]+$
Location : path
Type : string
Required : Yes
Description : Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}.
updateMask
Type : string
Format : google-fieldmask
Description : Field mask specifying the fields in the above SfdcChannel that have been modified and need to be updated.
Location : query
Description : Updates an sfdc channel. Updates the sfdc channel in spanner. Returns the sfdc channel.
▼ ▲ integrations.projects.locations.products.sfdcInstances.sfdcChannels.get
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1alpha/{+name}
Parameter Order : name
HTTP Method : GET
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}
Description : Gets an sfdc channel. If the channel doesn't exist, Code.NOT_FOUND exception will be thrown.
Parameters :
name
Description : Required. The name that is associated with the SfdcChannel.
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+/sfdcChannels/[^/]+$
Type : string
▼ ▲ integrations.projects.locations.products.sfdcInstances.sfdcChannels.list
Description : Lists all sfdc channels that match the filter. Restrict to sfdc channels belonging to the current client only.
HTTP Method : GET
Path : v1alpha/{+parent}/sfdcChannels
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels
Parameters :
pageToken
Description : The token returned in the previous response.
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
pageSize
Location : query
Description : The size of entries in the response. If unspecified, defaults to 100.
Format : int32
Type : integer
filter
Description : Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters.
Location : query
Type : string
parent
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+$
Required : Yes
Location : path
Type : string
Description : Required. The client, which owns this collection of SfdcChannels.
▼ ▲ integrations.projects.locations.products.integrations.schedule
HTTP Method : POST
Path : v1alpha/{+name}:schedule
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:schedule
Description : Schedules an integration for execution by passing the trigger id and the scheduled time in the request body.
Parameters :
name
Type : string
Description : The integration resource name.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$
Location : path
Parameter Order : name
▼ ▲ integrations.projects.locations.products.integrations.monitorexecutionstats
Description : Get execution stats
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:monitorexecutionstats
Parameters :
parent
Type : string
Description : Required. The parent resource name: {parent=projects/*/locations/*}.
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$
Parameter Order : parent
HTTP Method : POST
Path : v1alpha/{+parent}:monitorexecutionstats
▼ ▲ integrations.projects.locations.products.integrations.list
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations
Description : Returns the list of all integrations in the specified project.
Parameter Order : parent
Path : v1alpha/{+parent}/integrations
Parameters :
pageSize
Description : The page size for the resquest.
Location : query
Format : int32
Type : integer
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
pageToken
Type : string
Location : query
Description : The page token for the resquest.
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
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
▼ ▲ integrations.projects.locations.products.integrations.archiveBundle
Description : PROTECT WITH A VISIBILITY LABEL. THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. Soft-deletes the bundle.
Parameters :
name
Type : string
Required : Yes
Location : path
Description : Required. The bundle to archive. Format: projects/{project}/locations/{location}/integrations/{integration}
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1alpha/{+name}:archiveBundle
HTTP Method : POST
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:archiveBundle
Parameter Order : name
▼ ▲ integrations.projects.locations.products.integrations.execute
Parameter Order : name
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:execute
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.
Parameters :
name
Description : Required. The integration resource name.
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$
Required : Yes
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Path : v1alpha/{+name}:execute
▼ ▲ integrations.projects.locations.products.integrations.executionsnapshots.list
Path : v1alpha/{+parent}/executionsnapshots
Description : Lists the snapshots of a given integration executions. This RPC is not being used.
Parameters :
filter
Type : string
Location : query
Description : Currently supports filter by `execution_info_id` or `execution_snapshot_id`.
readMask
Format : google-fieldmask
Description : 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 event execution snapshot will be filled and returned.
Type : string
Location : query
parent
Type : string
Required : Yes
Description : Required. The parent resource name of the integration execution.
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$
Location : path
pageToken
Type : string
Description : The token used to retrieve the next page results.
Location : query
pageSize
Description : Number of entries to be returned in a page.
Location : query
Format : int32
Type : integer
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executionsnapshots
HTTP Method : GET
Parameter Order : parent
▼ ▲ integrations.projects.locations.products.integrations.versions.download
Description : Downloads an integration. Retrieves the `IntegrationVersion` for a given `integration_id` and returns the response as a string.
Parameters :
fileFormat
Enum :
Description : File format for download request.
Enum Descriptions :
Type : string
Location : query
name
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$
Location : path
Description : Required. The version to download. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Required : Yes
Type : string
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:download
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Path : v1alpha/{+name}:download
▼ ▲ integrations.projects.locations.products.integrations.versions.validate
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:validate
Path : v1alpha/{+name}:validate
Parameter Order : name
Description : Validates the given integration. If the id doesn't exist, a NotFoundException is thrown. If validation fails a CanonicalCodeException is thrown. If there was no failure an empty response is returned.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Required : Yes
Description : Required. The version to validate. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$
HTTP Method : POST
▼ ▲ integrations.projects.locations.products.integrations.versions.getBundle
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:getBundle
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Required : Yes
Description : Required. The bundle name.
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$
Type : string
Path : v1alpha/{+name}:getBundle
Description : PROTECT WITH A VISIBILITY LABEL. THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. RPC to get details of the Bundle
HTTP Method : GET
▼ ▲ integrations.projects.locations.products.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.
Parameter Order : parent
Path : v1alpha/{+parent}/versions:upload
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions:upload
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
parent
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$
Location : path
Type : string
Description : Required. The version to upload. Format: projects/{project}/locations/{location}/integrations/{integration}
▼ ▲ integrations.projects.locations.products.integrations.versions.patch
Parameters :
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
name
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$
Type : string
Location : path
Required : Yes
Description : Output only. Auto-generated primary key.
HTTP Method : PATCH
Path : v1alpha/{+name}
Description : Update a integration with a draft version in the specified project.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}
Parameter Order : name
▼ ▲ integrations.projects.locations.products.integrations.versions.takeoverEditLock
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:takeoverEditLock
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.
HTTP Method : POST
Parameter Order : integrationVersion
Path : v1alpha/{+integrationVersion}:takeoverEditLock
Parameters :
integrationVersion
Required : Yes
Location : path
Type : string
Description : Required. The version to take over edit lock. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$
▼ ▲ integrations.projects.locations.products.integrations.versions.archive
HTTP Method : POST
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 archived is DRAFT, and if the `locked_by` user is not the same as the user performing the Archive. Audit fields updated include last_modified_timestamp, last_modified_by. Any existing lock is released when Archiving a integration. Currently, there is no unarchive mechanism.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:archive
Path : v1alpha/{+name}:archive
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$
Required : Yes
Location : path
Description : Required. The version to archive. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
▼ ▲ integrations.projects.locations.products.integrations.versions.deactivate
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Type : string
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$
Description : Required. The version to deactivate. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Path : v1alpha/{+name}:deactivate
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.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:deactivate
HTTP Method : POST
Parameter Order : name
▼ ▲ integrations.projects.locations.products.integrations.versions.updateBundle
HTTP Method : PATCH
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. RPC to update the Bundle
Parameters :
name
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$
Type : string
Description : Required. Bundle name
Location : path
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:updateBundle
Parameter Order : name
Path : v1alpha/{+name}:updateBundle
▼ ▲ integrations.projects.locations.products.integrations.versions.publish
HTTP Method : POST
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.
Path : v1alpha/{+name}:publish
Parameters :
name
Description : Required. The version to publish. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Location : path
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:publish
Parameter Order : name
▼ ▲ integrations.projects.locations.products.integrations.versions.list
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions
Path : v1alpha/{+parent}/versions
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
Description : Returns the list of all integration versions in the specified project.
Parameters :
pageSize
Type : integer
Location : query
Format : int32
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.
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", "snapshot_number" Ascending sort order for "name".
Location : query
fieldMask
Type : string
Location : query
Format : google-fieldmask
Description : The field mask which specifies the particular data to be returned.
parent
Required : Yes
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$
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". 3. projects//locations/-/integrations/- Meaning: "List versions (with filter) for a client".
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`.
Location : query
Type : string
pageToken
Location : query
Type : string
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.
▼ ▲ integrations.projects.locations.products.integrations.versions.get
HTTP Method : GET
Description : Get a integration in the specified project.
Parameters :
name
Description : Required. The version to retrieve. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$
Type : string
Required : Yes
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}
Path : v1alpha/{+name}
Parameter Order : name
▼ ▲ integrations.projects.locations.products.integrations.versions.create
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
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.
parent
Required : Yes
Description : Required. The parent resource where this version will be created. Format: projects/{project}/locations/{location}/integrations/{integration}
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$
Type : string
Location : path
Path : v1alpha/{+parent}/versions
Description : Create a integration with a draft version in the specified project.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions
HTTP Method : POST
▼ ▲ integrations.projects.locations.products.integrations.executions.suspensions.lift
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/executions/[^/]+/suspensions/[^/]+$
Type : string
Required : Yes
Location : path
Description : Required. The resource that the suspension belongs to. "projects/{project}/locations/{location}/products/{product}/integrations/{integration}/executions/{execution}/suspensions/{suspenion}" format.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:lift
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1alpha/{+name}:lift
Description : * Lifts suspension for advanced suspension task. Fetch corresponding suspension with provided suspension Id, resolve suspension, and set up suspension result for the Suspension Task.
HTTP Method : POST
▼ ▲ integrations.projects.locations.products.integrations.executions.suspensions.list
Parameter Order : parent
Path : v1alpha/{+parent}/suspensions
HTTP Method : GET
Parameters :
filter
Location : query
Description : Standard filter field.
Type : string
orderBy
Description : Field name to order by.
Location : query
Type : string
pageToken
Location : query
Description : Token to retrieve a specific page.
Type : string
parent
Description : Required. projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_name}/executions/{execution_name}
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/executions/[^/]+$
Type : string
pageSize
Location : query
Description : Maximum number of entries in the response.
Format : int32
Type : integer
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions
Description : * Lists suspensions associated with a specific execution. Only those with permissions to resolve the relevant suspensions will be able to view them.
▼ ▲ integrations.projects.locations.products.integrations.executions.suspensions.resolve
Parameter Order : name
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:resolve
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.
Path : v1alpha/{+name}:resolve
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/executions/[^/]+/suspensions/[^/]+$
Description : Required. projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_name}/executions/{execution_name}/suspensions/{suspension_id}
Required : Yes
▼ ▲ integrations.projects.locations.products.integrations.executions.list
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
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.
Path : v1alpha/{+parent}/executions
HTTP Method : GET
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions
Parameters :
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
filterParams.startTime
Type : string
Format : int64
Description : Start timestamp.
Location : query
pageToken
Location : query
Type : string
Description : Optional. The token returned in the previous response.
parent
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$
Description : Required. The parent resource name of the integration execution.
Type : string
Location : path
Required : Yes
filterParams.workflowName
Type : string
Description : Workflow name.
Location : query
filterParams.parameterKey
Type : string
Location : query
Description : Param key. DEPRECATED. User parameter_pair_key instead.
readMask
Type : string
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 event execution info will be filled and returned.
Format : google-fieldmask
Location : query
filterParams.taskStatuses
Description : List of possible task statuses.
Type : string
Location : query
Repeated : Yes
filterParams.endTime
Description : End timestamp.
Location : query
Type : string
Format : int64
filterParams.parameterType
Location : query
Type : string
Description : Param type.
filterParams.eventStatuses
Type : string
Location : query
Repeated : Yes
Description : List of possible event statuses.
filter
Type : string
Location : query
Description : Optional. Standard filter field, we support filtering on all fields in EventExecutionParamIndexes table. All fields support for EQUALS, in additional: CreateTimestamp support for LESS_THAN, GREATER_THAN ParameterKey, ParameterValue, ParameterType support for HAS For example: "parameter_value" HAS \"parameter1\" Also supports operators like AND, OR, NOT For example, trigger_id=\"id1\" AND event_execution_state=\"FAILED\"
filterParams.executionId
Location : query
Type : string
Description : Execution id.
orderBy
Description : Optional. The results would be returned in order you specified here. Currently supporting "last_modified_time" and "create_time".
Location : query
Type : string
filterParams.customFilter
Location : query
Description : Optional user-provided custom filter.
Type : string
truncateParams
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.
Type : boolean
filterParams.parameterPairValue
Location : query
Description : Param value in the key value pair filter.
Type : string
filterParams.parameterValue
Type : string
Description : Param value. DEPRECATED. User parameter_pair_value instead.
Location : query
pageSize
Location : query
Format : int32
Description : Optional. The size of entries in the response.
Type : integer
filterParams.parameterPairKey
Location : query
Description : Param key in the key value pair filter.
Type : string
▼ ▲ integrations.projects.locations.products.integrations.executions.cancel
Description : Cancellation of an execution
Parameter Order : name
Path : v1alpha/{+name}:cancel
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}:cancel
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/executions/[^/]+$
Type : string
Required : Yes
Location : path
Description : Required. The execution resource name. Format: projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_id}/executions/{execution_id}
HTTP Method : POST
▼ ▲ integrations.projects.locations.products.integrations.executions.get
Parameter Order : name
HTTP Method : GET
Parameters :
name
Required : Yes
Location : path
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/[^/]+$
Type : string
Path : v1alpha/{+name}
Description : Get an execution in the specified project.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}
▼ ▲ integrations.projects.locations.products.integrationtemplates.versions.create
Parameter Order : parent
Description : Creates an IntegrationTemplateVersion.
Path : v1alpha/{+parent}/versions
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrationtemplates/{integrationtemplatesId}/versions
Parameters :
parent
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrationtemplates/[^/]+$
Location : path
Description : Required. The parent resource where this TemplateVersion will be created. Format: projects/{project}/location/{location}/product/{product}/integrationtemplates/{integrationtemplate}
Required : Yes
Type : string
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
▼ ▲ integrations.projects.locations.products.integrationtemplates.versions.get
Parameters :
name
Description : Required. The TemplateVersion to retrieve. Format: projects/{project}/locations/{location}/products/{product}/integrationtemplates/{integrationtemplate}/versions/{version}
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrationtemplates/[^/]+/versions/[^/]+$
Type : string
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrationtemplates/{integrationtemplatesId}/versions/{versionsId}
Path : v1alpha/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Parameter Order : name
Description : Returns an IntegrationTemplateVersion in the specified project.
▼ ▲ integrations.projects.locations.products.integrationtemplates.versions.list
HTTP Method : GET
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrationtemplates/{integrationtemplatesId}/versions
Parameters :
pageSize
Location : query
Type : integer
Format : int32
Description : The maximum number of IntegrationTemplateVersions 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.
pageToken
Description : A page token, received from a previous `ListIntegrationTemplateVersions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIntegrationTemplateVersions` must match the call that provided the page token.
Location : query
Type : string
parent
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrationtemplates/[^/]+$
Description : Required. Format: projects/{project}/location/{location}/product/{product}/integrationtemplates/{integrationtemplate}
Location : path
Required : Yes
filter
Description : Filter syntax: defined in the EBNF grammar.
Type : string
Location : query
Parameter Order : parent
Description : Returns the list of all IntegrationTemplateVersions in the specified project.
Path : v1alpha/{+parent}/versions
▼ ▲ integrations.projects.locations.products.createBundle
Path : v1alpha/{+parent}:createBundle
Description : PROTECT WITH A VISIBILITY LABEL. THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. Create a bundle.
Parameters :
parent
Description : Required. The location resource of the request.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+$
Location : path
Type : string
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}:createBundle
HTTP Method : POST
▼ ▲ integrations.projects.locations.products.listTaskEntities
HTTP Method : GET
Parameter Order : parent
Description : This is a UI only method and will be moved away. Returns a list of common tasks.
Path : v1alpha/{+parent}:listTaskEntities
Parameters :
parent
Location : path
Description : Required. The location resource of the request. This is not going to be used but preserve the field for future.
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+$
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}:listTaskEntities
▼ ▲ integrations.projects.locations.certificates.get
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Description : Get a certificates in the specified project.
Path : v1alpha/{+name}
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/certificates/{certificatesId}
Parameters :
name
Description : Required. The certificate to retrieve. Format: projects/{project}/locations/{location}/certificates/{certificate}
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/certificates/[^/]+$
Required : Yes
Location : path
Parameter Order : name
▼ ▲ integrations.projects.locations.sfdcInstances.delete
Parameters :
name
Type : string
Description : Required. The name that is associated with the SfdcInstance.
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+$
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}
Description : Deletes an sfdc instance.
Path : v1alpha/{+name}
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : DELETE
▼ ▲ integrations.projects.locations.sfdcInstances.get
Parameter Order : name
Parameters :
name
Required : Yes
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+$
Description : Required. The name that is associated with the SfdcInstance.
Path : v1alpha/{+name}
Description : Gets an sfdc instance. If the instance doesn't exist, Code.NOT_FOUND exception will be thrown.
HTTP Method : GET
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}
▼ ▲ integrations.projects.locations.sfdcInstances.patch
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}
Description : Updates an sfdc instance. Updates the sfdc instance in spanner. Returns the sfdc instance.
Parameter Order : name
Path : v1alpha/{+name}
HTTP Method : PATCH
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
updateMask
Type : string
Location : query
Description : Field mask specifying the fields in the above SfdcInstance that have been modified and need to be updated.
Format : google-fieldmask
name
Description : Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}.
Required : Yes
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+$
▼ ▲ integrations.projects.locations.sfdcInstances.create
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1alpha/{+parent}/sfdcInstances
Description : Creates an sfdc instance record. Store the sfdc instance in Spanner. Returns the sfdc instance.
HTTP Method : POST
Parameters :
parent
Pattern : ^projects/[^/]+/locations/[^/]+$
Description : Required. "projects/{project}/locations/{location}" format.
Required : Yes
Location : path
Type : string
Parameter Order : parent
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/sfdcInstances
▼ ▲ integrations.projects.locations.sfdcInstances.list
Parameters :
pageSize
Type : integer
Description : The size of entries in the response. If unspecified, defaults to 100.
Format : int32
Location : query
filter
Description : Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters.
Location : query
Type : string
parent
Description : Required. The client, which owns this collection of SfdcInstances.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Type : string
Required : Yes
pageToken
Location : query
Description : The token returned in the previous response.
Type : string
readMask
Format : google-fieldmask
Description : The mask which specifies fields that need to be returned in the SfdcInstance's response.
Type : string
Location : query
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists all sfdc instances that match the filter. Restrict to sfdc instances belonging to the current client only.
Path : v1alpha/{+parent}/sfdcInstances
HTTP Method : GET
Parameter Order : parent
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/sfdcInstances
▼ ▲ integrations.projects.locations.sfdcInstances.sfdcChannels.patch
Parameter Order : name
Path : v1alpha/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates an sfdc channel. Updates the sfdc channel in spanner. Returns the sfdc channel.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}
Parameters :
name
Description : Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}.
Required : Yes
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+/sfdcChannels/[^/]+$
updateMask
Location : query
Description : Field mask specifying the fields in the above SfdcChannel that have been modified and need to be updated.
Type : string
Format : google-fieldmask
HTTP Method : PATCH
▼ ▲ integrations.projects.locations.sfdcInstances.sfdcChannels.create
Parameters :
parent
Location : path
Description : Required. "projects/{project}/locations/{location}" format.
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+$
Description : Creates an sfdc channel record. Store the sfdc channel in Spanner. Returns the sfdc channel.
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Parameter Order : parent
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels
Path : v1alpha/{+parent}/sfdcChannels
▼ ▲ integrations.projects.locations.sfdcInstances.sfdcChannels.get
Parameter Order : name
Parameters :
name
Description : Required. The name that is associated with the SfdcChannel.
Pattern : ^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+/sfdcChannels/[^/]+$
Required : Yes
Location : path
Type : string
Path : v1alpha/{+name}
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}
HTTP Method : GET
Description : Gets an sfdc channel. If the channel doesn't exist, Code.NOT_FOUND exception will be thrown.
▼ ▲ integrations.projects.locations.sfdcInstances.sfdcChannels.list
Parameters :
readMask
Location : query
Type : string
Description : The mask which specifies fields that need to be returned in the SfdcChannel's response.
Format : google-fieldmask
pageSize
Type : integer
Description : The size of entries in the response. If unspecified, defaults to 100.
Location : query
Format : int32
pageToken
Type : string
Location : query
Description : The token returned in the previous response.
filter
Location : query
Type : string
Description : Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters.
parent
Description : Required. The client, which owns this collection of SfdcChannels.
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+$
Required : Yes
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1alpha/{+parent}/sfdcChannels
Description : Lists all sfdc channels that match the filter. Restrict to sfdc channels belonging to the current client only.
Parameter Order : parent
HTTP Method : GET
▼ ▲ integrations.projects.locations.sfdcInstances.sfdcChannels.delete
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Description : Deletes an sfdc channel.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}
Path : v1alpha/{+name}
HTTP Method : DELETE
Parameters :
name
Required : Yes
Location : path
Description : Required. The name that is associated with the SfdcChannel.
Pattern : ^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+/sfdcChannels/[^/]+$
Type : string
▼ ▲ integrations.projects.locations.appsScriptProjects.link
Parameters :
parent
Description : Required. The project that the executed integration belongs to.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/appsScriptProjects:link
Parameter Order : parent
Path : v1alpha/{+parent}/appsScriptProjects:link
Description : Links a existing Apps Script project.
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
▼ ▲ integrations.projects.locations.appsScriptProjects.create
Description : Creates an Apps Script project.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/appsScriptProjects
Parameters :
parent
Required : Yes
Description : Required. The project that the executed integration belongs to.
Pattern : ^projects/[^/]+/locations/[^/]+$
Type : string
Location : path
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1alpha/{+parent}/appsScriptProjects
HTTP Method : POST
▼ ▲ integrations.projects.locations.integrations.executions.list
HTTP Method : GET
Parameters :
pageSize
Format : int32
Description : Optional. The size of entries in the response.
Location : query
Type : integer
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.
Location : query
Type : boolean
filterParams.parameterKey
Type : string
Description : Param key. DEPRECATED. User parameter_pair_key instead.
Location : query
parent
Description : Required. The parent resource name of the integration execution.
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+$
Type : string
Required : Yes
filterParams.parameterPairKey
Location : query
Description : Param key in the key value pair filter.
Type : string
filterParams.parameterPairValue
Description : Param value in the key value pair filter.
Location : query
Type : string
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 event execution info will be filled and returned.
Type : string
Format : google-fieldmask
filterParams.executionId
Type : string
Location : query
Description : Execution id.
filterParams.eventStatuses
Location : query
Description : List of possible event statuses.
Repeated : Yes
Type : string
pageToken
Type : string
Description : Optional. The token returned in the previous response.
Location : query
filterParams.customFilter
Type : string
Location : query
Description : Optional user-provided custom filter.
filterParams.parameterValue
Description : Param value. DEPRECATED. User parameter_pair_value instead.
Type : string
Location : query
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
filter
Location : query
Description : Optional. Standard filter field, we support filtering on all fields in EventExecutionParamIndexes table. All fields support for EQUALS, in additional: CreateTimestamp support for LESS_THAN, GREATER_THAN ParameterKey, ParameterValue, ParameterType support for HAS For example: "parameter_value" HAS \"parameter1\" Also supports operators like AND, OR, NOT For example, trigger_id=\"id1\" AND event_execution_state=\"FAILED\"
Type : string
filterParams.workflowName
Type : string
Description : Workflow name.
Location : query
orderBy
Type : string
Description : Optional. The results would be returned in order you specified here. Currently supporting "last_modified_time" and "create_time".
Location : query
filterParams.startTime
Type : string
Description : Start timestamp.
Location : query
Format : int64
filterParams.taskStatuses
Description : List of possible task statuses.
Type : string
Location : query
Repeated : Yes
filterParams.endTime
Location : query
Type : string
Format : int64
Description : End timestamp.
filterParams.parameterType
Description : Param type.
Type : string
Location : query
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions
Path : v1alpha/{+parent}/executions
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.
▼ ▲ integrations.projects.locations.integrations.versions.list
HTTP Method : GET
Description : Returns the list of all integration versions in the specified project.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/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". 3. projects//locations/-/integrations/- Meaning: "List versions (with filter) for a client".
Type : string
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+$
pageToken
Location : query
Type : string
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.
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`.
fieldMask
Format : google-fieldmask
Description : The field mask which specifies the particular data to be returned.
Type : string
Location : query
pageSize
Location : query
Type : integer
Format : int32
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.
orderBy
Location : query
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", "snapshot_number" Ascending sort order for "name".
Type : string
Path : v1alpha/{+parent}/versions
▼ ▲ integrations.projects.locations.integrations.versions.publish
HTTP Method : POST
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.
Parameters :
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$
Type : string
Required : Yes
Description : Required. The version to publish. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Parameter Order : name
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:publish
Path : v1alpha/{+name}:publish
▼ ▲ integrations.projects.locations.integrations.versions.get
Parameters :
name
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$
Type : string
Description : Required. The version to retrieve. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Location : path
HTTP Method : GET
Description : Get a integration in the specified project.
Path : v1alpha/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}
▼ ▲ integrations.projects.locations.integrations.versions.validate
Parameter Order : name
HTTP Method : POST
Description : Validates the given integration. If the id doesn't exist, a NotFoundException is thrown. If validation fails a CanonicalCodeException is thrown. If there was no failure an empty response is returned.
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1alpha/{+name}:validate
Parameters :
name
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$
Description : Required. The version to validate. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Required : Yes
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:validate
▼ ▲ integrations.projects.locations.integrations.versions.deactivate
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:deactivate
Parameters :
name
Type : string
Required : Yes
Description : Required. The version to deactivate. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$
HTTP Method : POST
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.
Parameter Order : name
Path : v1alpha/{+name}:deactivate
▼ ▲ integrations.projects.locations.integrations.versions.takeoverEditLock
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
integrationVersion
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$
Description : Required. The version to take over edit lock. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Required : Yes
Location : path
Parameter Order : integrationVersion
HTTP Method : POST
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.
Path : v1alpha/{+integrationVersion}:takeoverEditLock
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:takeoverEditLock
▼ ▲ integrations.projects.locations.integrations.versions.patch
Description : Update a integration with a draft version in the specified project.
HTTP Method : PATCH
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$
Type : string
Description : Output only. Auto-generated primary key.
Location : path
Required : Yes
updateMask
Description : Field mask specifying the fields in the above integration that have been modified and need to be updated.
Format : google-fieldmask
Location : query
Type : string
Path : v1alpha/{+name}
▼ ▲ integrations.projects.locations.integrations.versions.create
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions
HTTP Method : POST
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
parent
Description : Required. The parent resource where this version will be created. Format: projects/{project}/locations/{location}/integrations/{integration}
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+$
Location : path
Required : Yes
Description : Create a integration with a draft version in the specified project.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
Path : v1alpha/{+parent}/versions
▼ ▲ integrations.projects.locations.integrations.versions.archive
HTTP Method : POST
Path : v1alpha/{+name}:archive
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:archive
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Required : Yes
Description : Required. The version to archive. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$
Type : string
Location : path
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 archived is DRAFT, and if the `locked_by` user is not the same as the user performing the Archive. Audit fields updated include last_modified_timestamp, last_modified_by. Any existing lock is released when Archiving a integration. Currently, there is no unarchive mechanism.
Parameter Order : name
▼ ▲ integrations.projects.locations.integrations.execute
Path : v1alpha/{+name}:execute
Parameter Order : name
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.
HTTP Method : POST
Parameters :
name
Description : Required. The integration resource name.
Location : path
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+$
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:execute
▼ ▲ integrations.projects.locations.integrations.list
HTTP Method : GET
Parameter Order : parent
Description : Returns the list of all integrations in the specified project.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
pageSize
Type : integer
Location : query
Description : The page size for the resquest.
Format : int32
pageToken
Location : query
Type : string
Description : The page token for the resquest.
orderBy
Location : query
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
parent
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Type : string
Description : Required. Project and location from which the integrations should be listed. Format: projects/{project}
Required : Yes
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
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/integrations
Path : v1alpha/{+parent}/integrations
▼ ▲ integrations.projects.locations.integrations.monitorexecutionstats
Parameter Order : parent
Description : Get execution stats
Parameters :
parent
Required : Yes
Description : Required. The parent resource name: {parent=projects/*/locations/*}.
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+$
Location : path
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1alpha/{+parent}:monitorexecutionstats
HTTP Method : POST
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:monitorexecutionstats
▼ ▲ integrations.projects.locations.integrations.schedule
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+$
Type : string
Location : path
Description : The integration resource name.
Path : v1alpha/{+name}:schedule
Description : Schedules an integration for execution by passing the trigger id and the scheduled time in the request body.
Parameter Order : name
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:schedule
HTTP Method : POST
▼ ▲ integrations.projects.locations.authConfigs.patch
Path : v1alpha/{+name}
Parameters :
name
Description : Resource name of the SFDC instance projects/{project}/locations/{location}/authConfigs/{authConfig}.
Required : Yes
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/authConfigs/[^/]+$
clientCertificate.encryptedPrivateKey
Location : query
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-----
clientCertificate.sslCertificate
Type : string
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-----
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
Description : Field mask specifying the fields in the above AuthConfig that have been modified and need to be updated.
Location : query
Format : google-fieldmask
Type : string
Scopes : https://www.googleapis.com/auth/cloud-platform
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
Parameter Order : name
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/authConfigs/{authConfigsId}
▼ ▲ integrations.projects.locations.authConfigs.list
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists all auth configs that match the filter. Restrict to auth configs belong to the current client only.
HTTP Method : GET
Parameters :
filter
Type : string
Location : query
Description : Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters.
parent
Description : Required. The client, which owns this collection of AuthConfigs.
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
readMask
Type : string
Description : The mask which specifies fields that need to be returned in the AuthConfig's response.
Format : google-fieldmask
Location : query
pageSize
Location : query
Format : int32
Type : integer
Description : The size of entries in the response. If unspecified, defaults to 100.
pageToken
Type : string
Description : The token returned in the previous response.
Location : query
Path : v1alpha/{+parent}/authConfigs
Parameter Order : parent
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/authConfigs
▼ ▲ integrations.projects.locations.authConfigs.create
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.passphrase
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.
Location : query
clientCertificate.sslCertificate
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
Description : Required. "projects/{project}/locations/{location}" format.
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
Type : string
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
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/authConfigs
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1alpha/{+parent}/authConfigs
Parameter Order : parent
▼ ▲ integrations.projects.locations.authConfigs.delete
Path : v1alpha/{+name}
Description : Deletes an auth config.
Parameters :
name
Description : Required. The name that is associated with the AuthConfig.
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/authConfigs/[^/]+$
Required : Yes
Type : string
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/authConfigs/{authConfigsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
HTTP Method : DELETE
▼ ▲ integrations.projects.locations.authConfigs.get
HTTP Method : GET
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.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/authConfigs/{authConfigsId}
Parameter Order : name
Parameters :
name
Description : Required. The name that is associated with the AuthConfig.
Pattern : ^projects/[^/]+/locations/[^/]+/authConfigs/[^/]+$
Location : path
Required : Yes
Type : string
Path : v1alpha/{+name}
▼ ▲ integrations.projects.locations.connections.list
Parameters :
pageToken
Type : string
Description : Page token.
Location : query
orderBy
Description : Order by parameters.
Type : string
Location : query
pageSize
Format : int32
Location : query
Description : Page size.
Type : integer
parent
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
Required : Yes
Type : string
Description : Required. Parent resource of the Connection, of the form: `projects/*/locations/*`
filter
Location : query
Description : Filter.
Type : string
Parameter Order : parent
Path : v1alpha/{+parent}/connections
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists Connections in a given project and location.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/connections
HTTP Method : GET
▼ ▲ integrations.projects.locations.connections.getConnectionSchemaMetadata
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists the available entities and actions associated with a Connection.
Parameter Order : name
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/connectionSchemaMetadata
HTTP Method : GET
Parameters :
name
Description : Required. ConnectionSchemaMetadata name. Format: projects/{project}/locations/{location}/connections/{connection}/connectionSchemaMetadata
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/connections/[^/]+/connectionSchemaMetadata$
Required : Yes
Type : string
Path : v1alpha/{+name}
▼ ▲ integrations.projects.locations.connections.runtimeEntitySchemas.list
Path : v1alpha/{+parent}/runtimeEntitySchemas
Parameters :
pageSize
Location : query
Description : Page size.
Format : int32
Type : integer
parent
Pattern : ^projects/[^/]+/locations/[^/]+/connections/[^/]+$
Location : path
Type : string
Description : Required. Parent resource of RuntimeEntitySchema. Format: projects/{project}/locations/{location}/connections/{connection}
Required : Yes
pageToken
Location : query
Description : Page token.
Type : string
filter
Description : Filter. Only the entity field with literal equality operator is supported.
Type : string
Location : query
Parameter Order : parent
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/runtimeEntitySchemas
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Description : Lists the JSON schemas for the properties of runtime entities, filtered by entity name.
▼ ▲ integrations.projects.locations.connections.runtimeActionSchemas.list
Parameters :
pageSize
Location : query
Description : Page size.
Type : integer
Format : int32
pageToken
Description : Page token.
Location : query
Type : string
filter
Description : Filter. Only the action field with literal equality operator is supported.
Type : string
Location : query
parent
Required : Yes
Description : Required. Parent resource of RuntimeActionSchema. Format: projects/{project}/locations/{location}/connections/{connection}
Pattern : ^projects/[^/]+/locations/[^/]+/connections/[^/]+$
Location : path
Type : string
Path : v1alpha/{+parent}/runtimeActionSchemas
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/runtimeActionSchemas
Description : Lists the JSON schemas for the inputs and outputs of actions, filtered by action name.
Parameter Order : parent
▼ ▲ integrations.projects.locations.listTaskEntities
Description : This is a UI only method and will be moved away. Returns a list of common tasks.
Path : v1alpha/{+parent}:listTaskEntities
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}:listTaskEntities
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Parameters :
parent
Description : Required. The location resource of the request. This is not going to be used but preserve the field for future.
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+$
Required : Yes
Location : path
Parameter Order : parent
▼ ▲ integrations.callback.generateToken
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1alpha/callback:generateToken
Parameters :
product
Enum :
Type : string
Location : query
Description : Which product sends the request
Enum Descriptions :
redirectUri
Type : string
Description : Redirect uri of the auth code request
Location : query
gcpProjectId
Type : string
Location : query
Description : The gcp project id of the request
state
Type : string
Description : The auth config id for the given request
Location : query
code
Description : The auth code for the given request
Type : string
Location : query
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.
HTTP Method : GET
Flat Path : v1alpha/callback:generateToken