| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="integrations_v1.html">Application Integration API</a> . <a href="integrations_v1.projects.html">projects</a> . <a href="integrations_v1.projects.locations.html">locations</a> . <a href="integrations_v1.projects.locations.clients.html">clients</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#changeConfig">changeConfig(parent, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Updates the client customer configuration for the given project and location resource name</p> |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#deprovision">deprovision(parent, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Perform the deprovisioning steps to disable a user GCP project to use IP and purge all related data in a wipeout-compliant way.</p> |
| <p class="toc_element"> |
| <code><a href="#provision">provision(parent, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Perform the provisioning steps to enable a user GCP project to use IP. If GCP project already registered on IP end via Apigee Integration, provisioning will fail.</p> |
| <p class="toc_element"> |
| <code><a href="#provisionClientPostProcessor">provisionClientPostProcessor(parent, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Perform post provisioning steps after client is provisioned.</p> |
| <p class="toc_element"> |
| <code><a href="#replace">replace(parent, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Update run-as service account for provisioned client</p> |
| <p class="toc_element"> |
| <code><a href="#switch">switch(parent, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Update client from GMEK to CMEK</p> |
| <p class="toc_element"> |
| <code><a href="#switchVariableMasking">switchVariableMasking(parent, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Update variable masking for provisioned client</p> |
| <p class="toc_element"> |
| <code><a href="#toggleHttp">toggleHttp(parent, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Enable/Disable http call for provisioned client</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="changeConfig">changeConfig(parent, body=None, x__xgafv=None)</code> |
| <pre>Updates the client customer configuration for the given project and location resource name |
| |
| Args: |
| parent: string, Required. Required: Format - projects/{project}/locations/{location} (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Request for the ChangeCustomerConfig rpc |
| "customerConfig": { # Customer configuration information for the given client # Optional. The customer configuration to be updated. |
| "cloudKmsConfig": { # Configuration information for Client's Cloud KMS information # Optional. Cloud KMS config for Auth Module to encrypt/decrypt credentials. |
| "key": "A String", # Required. A Cloud KMS key is a named object containing one or more key versions, along with metadata for the key. A key exists on exactly one key ring tied to a specific location. |
| "keyVersion": "A String", # Optional. Each version of a key contains key material used for encryption or signing. A key's version is represented by an integer, starting at 1. To decrypt data or verify a signature, you must use the same key version that was used to encrypt or sign the data. |
| "kmsLocation": "A String", # Required. Location name of the key ring, e.g. "us-west1". |
| "kmsProjectId": "A String", # Optional. The gcp project id of the project where the kms key stored. If empty, the kms key is stored at the same project as customer's project and ecrypted with CMEK, otherwise, the kms key is stored in the tenant project and encrypted with GMEK |
| "kmsRing": "A String", # Required. A key ring organizes keys in a specific Google Cloud location and allows you to manage access control on groups of keys. A key ring's name does not need to be unique across a Google Cloud project, but must be unique within a given location. |
| }, |
| "enableHttpCall": True or False, # Optional. Indicates if the client should be allowed to make HTTP calls. True if http call feature should be turned on for this region. |
| "enableManagedAiFeatures": True or False, # Optional. Indicates if the client should be allowed to use managed AI features, i.e. using Cloud Companion APIs of the tenant project. This will allow the customers to use features like Troubleshooting, OpenAPI spec enrichment, etc. for free. |
| "enableVariableMasking": True or False, # Optional. True if variable masking feature should be turned on for this region. |
| "runAsServiceAccount": "A String", # Optional. Run-as service account to be updated for the provisioned client. |
| }, |
| "updateMask": "A String", # Required. Field mask specifying the fields in the customer config that have been modified and must be updated. If absent or empty, no fields are updated. |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response for the ChangeCustomerConfig rpc |
| "customerConfig": { # Customer configuration information for the given client # Required. The updated customer configuration. |
| "cloudKmsConfig": { # Configuration information for Client's Cloud KMS information # Optional. Cloud KMS config for Auth Module to encrypt/decrypt credentials. |
| "key": "A String", # Required. A Cloud KMS key is a named object containing one or more key versions, along with metadata for the key. A key exists on exactly one key ring tied to a specific location. |
| "keyVersion": "A String", # Optional. Each version of a key contains key material used for encryption or signing. A key's version is represented by an integer, starting at 1. To decrypt data or verify a signature, you must use the same key version that was used to encrypt or sign the data. |
| "kmsLocation": "A String", # Required. Location name of the key ring, e.g. "us-west1". |
| "kmsProjectId": "A String", # Optional. The gcp project id of the project where the kms key stored. If empty, the kms key is stored at the same project as customer's project and ecrypted with CMEK, otherwise, the kms key is stored in the tenant project and encrypted with GMEK |
| "kmsRing": "A String", # Required. A key ring organizes keys in a specific Google Cloud location and allows you to manage access control on groups of keys. A key ring's name does not need to be unique across a Google Cloud project, but must be unique within a given location. |
| }, |
| "enableHttpCall": True or False, # Optional. Indicates if the client should be allowed to make HTTP calls. True if http call feature should be turned on for this region. |
| "enableManagedAiFeatures": True or False, # Optional. Indicates if the client should be allowed to use managed AI features, i.e. using Cloud Companion APIs of the tenant project. This will allow the customers to use features like Troubleshooting, OpenAPI spec enrichment, etc. for free. |
| "enableVariableMasking": True or False, # Optional. True if variable masking feature should be turned on for this region. |
| "runAsServiceAccount": "A String", # Optional. Run-as service account to be updated for the provisioned client. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="deprovision">deprovision(parent, body=None, x__xgafv=None)</code> |
| <pre>Perform the deprovisioning steps to disable a user GCP project to use IP and purge all related data in a wipeout-compliant way. |
| |
| Args: |
| parent: string, Required. Required: The ID of the GCP Project to be deprovisioned. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Request for the Deprovision rpc |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="provision">provision(parent, body=None, x__xgafv=None)</code> |
| <pre>Perform the provisioning steps to enable a user GCP project to use IP. If GCP project already registered on IP end via Apigee Integration, provisioning will fail. |
| |
| Args: |
| parent: string, Required. Required: The ID of the GCP Project to be provisioned. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Request for the Provision rpc |
| "cloudKmsConfig": { # Configuration information for Client's Cloud KMS information # Optional. OPTIONAL: Cloud KMS config for AuthModule to encrypt/decrypt credentials. |
| "key": "A String", # Required. A Cloud KMS key is a named object containing one or more key versions, along with metadata for the key. A key exists on exactly one key ring tied to a specific location. |
| "keyVersion": "A String", # Optional. Each version of a key contains key material used for encryption or signing. A key's version is represented by an integer, starting at 1. To decrypt data or verify a signature, you must use the same key version that was used to encrypt or sign the data. |
| "kmsLocation": "A String", # Required. Location name of the key ring, e.g. "us-west1". |
| "kmsProjectId": "A String", # Optional. The gcp project id of the project where the kms key stored. If empty, the kms key is stored at the same project as customer's project and ecrypted with CMEK, otherwise, the kms key is stored in the tenant project and encrypted with GMEK |
| "kmsRing": "A String", # Required. A key ring organizes keys in a specific Google Cloud location and allows you to manage access control on groups of keys. A key ring's name does not need to be unique across a Google Cloud project, but must be unique within a given location. |
| }, |
| "createSampleWorkflows": True or False, # Optional. Indicates if sample workflow should be created along with provisioning |
| "enableHttpCall": True or False, # Optional. Indicates if the client should be allowed to make HTTP calls. |
| "enableManagedAiFeatures": True or False, # Optional. Indicates if the client should be allowed to use managed AI features, i.e. using Cloud Companion APIs of the tenant project. This will allow the customers to use features like Troubleshooting, OpenAPI spec enrichment, etc. for free. |
| "provisionGmek": True or False, # Optional. Deprecated. Indicates provision with GMEK or CMEK. This field is deprecated and the provision would always be GMEK if cloud_kms_config is not present in the request. |
| "runAsServiceAccount": "A String", # Optional. User input run-as service account, if empty, will bring up a new default service account |
| "skipCpProvision": True or False, # Optional. Indicates if skip CP provision or not |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="provisionClientPostProcessor">provisionClientPostProcessor(parent, body=None, x__xgafv=None)</code> |
| <pre>Perform post provisioning steps after client is provisioned. |
| |
| Args: |
| parent: string, Required. Required: The ID of the GCP Project to be provisioned. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Request for PostProvisioning rpc call. |
| "workflows": [ # Optional. Indicate which workflows to create |
| "A String", |
| ], |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response for PostProvisioning rpc call. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="replace">replace(parent, body=None, x__xgafv=None)</code> |
| <pre>Update run-as service account for provisioned client |
| |
| Args: |
| parent: string, Required. Required: The ID of the GCP Project to be provisioned. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Request for the ReplaceServiceAccount rpc |
| "runAsServiceAccount": "A String", # Required. REQUIRED: Run-as service account to be updated |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="switch">switch(parent, body=None, x__xgafv=None)</code> |
| <pre>Update client from GMEK to CMEK |
| |
| Args: |
| parent: string, Required. Required: The ID of the GCP Project to be provisioned. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Request for the SwitchEncryption rpc |
| "cloudKmsConfig": { # Configuration information for Client's Cloud KMS information # Required. REQUIRED: Cloud KMS config for AuthModule to encrypt/decrypt credentials. |
| "key": "A String", # Required. A Cloud KMS key is a named object containing one or more key versions, along with metadata for the key. A key exists on exactly one key ring tied to a specific location. |
| "keyVersion": "A String", # Optional. Each version of a key contains key material used for encryption or signing. A key's version is represented by an integer, starting at 1. To decrypt data or verify a signature, you must use the same key version that was used to encrypt or sign the data. |
| "kmsLocation": "A String", # Required. Location name of the key ring, e.g. "us-west1". |
| "kmsProjectId": "A String", # Optional. The gcp project id of the project where the kms key stored. If empty, the kms key is stored at the same project as customer's project and ecrypted with CMEK, otherwise, the kms key is stored in the tenant project and encrypted with GMEK |
| "kmsRing": "A String", # Required. A key ring organizes keys in a specific Google Cloud location and allows you to manage access control on groups of keys. A key ring's name does not need to be unique across a Google Cloud project, but must be unique within a given location. |
| }, |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="switchVariableMasking">switchVariableMasking(parent, body=None, x__xgafv=None)</code> |
| <pre>Update variable masking for provisioned client |
| |
| Args: |
| parent: string, Required. Required: The ID of the GCP Project to be provisioned. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Request to enable/disable variable masking for a provisioned client |
| "enableVariableMasking": True or False, # Required. REQUIRED: True if variable masking feature should be turned on for this region |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="toggleHttp">toggleHttp(parent, body=None, x__xgafv=None)</code> |
| <pre>Enable/Disable http call for provisioned client |
| |
| Args: |
| parent: string, Required. Required: The ID of the GCP Project to be provisioned. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Request to enable/disable http call for a provisioned client |
| "enableHttpCall": True or False, # Required. REQUIRED: True if http call feature should be turned on for this region |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } |
| }</pre> |
| </div> |
| |
| </body></html> |
