Application Integration API . projects . locations . clients

Instance Methods

close()

Close httplib2 connections.

deprovision(parent, body=None, x__xgafv=None)

Perform the deprovisioning steps to disable a user GCP project to use IP and purge all related data in a wipeout-compliant way.

provision(parent, body=None, x__xgafv=None)

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.

replace(parent, body=None, x__xgafv=None)

Update run-as service account for provisioned client

switch(parent, body=None, x__xgafv=None)

Update client from GMEK to CMEK

switchVariableMasking(parent, body=None, x__xgafv=None)

Update variable masking for provisioned client

Method Details

close()
Close httplib2 connections.
deprovision(parent, body=None, x__xgafv=None)
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); }
}
provision(parent, body=None, x__xgafv=None)
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
  "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); }
}
replace(parent, body=None, x__xgafv=None)
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); }
}
switch(parent, body=None, x__xgafv=None)
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); }
}
switchVariableMasking(parent, body=None, x__xgafv=None)
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); }
}