class ProjectsLocationsProductsAuthConfigs extends Resource (View source)

The "authConfigs" collection of methods.

Typical usage is:

 $integrationsService = new Google\Service\Integrations(...);
 $authConfigs = $integrationsService->projects_locations_products_authConfigs;

Methods

create(string $parent, GoogleCloudIntegrationsV1alphaAuthConfig $postBody, array $optParams = [])

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.

delete(string $name, array $optParams = [])

Deletes an auth config. (authConfigs.delete)

get(string $name, array $optParams = [])

Gets a complete auth config. If the auth config doesn't exist, Code.NOT_FOUND exception will be thrown. Returns the decrypted auth config.

listProjectsLocationsProductsAuthConfigs(string $parent, array $optParams = [])

Lists all auth configs that match the filter. Restrict to auth configs belong to the current client only.

patch(string $name, GoogleCloudIntegrationsV1alphaAuthConfig $postBody, array $optParams = [])

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. (authConfigs.patch)

Details

GoogleCloudIntegrationsV1alphaAuthConfig create(string $parent, GoogleCloudIntegrationsV1alphaAuthConfig $postBody, array $optParams = [])

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. (authConfigs.create)

Parameters

string $parent

Required. "projects/{project}/locations/{location}" format.

GoogleCloudIntegrationsV1alphaAuthConfig $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudIntegrationsV1alphaAuthConfig

Exceptions

Exception

GoogleProtobufEmpty delete(string $name, array $optParams = [])

Deletes an auth config. (authConfigs.delete)

Parameters

string $name

Required. The name that is associated with the AuthConfig.

array $optParams

Optional parameters.

Return Value

GoogleProtobufEmpty

Exceptions

Exception

GoogleCloudIntegrationsV1alphaAuthConfig get(string $name, array $optParams = [])

Gets a complete auth config. If the auth config doesn't exist, Code.NOT_FOUND exception will be thrown. Returns the decrypted auth config.

(authConfigs.get)

Parameters

string $name

Required. The name that is associated with the AuthConfig.

array $optParams

Optional parameters.

Return Value

GoogleCloudIntegrationsV1alphaAuthConfig

Exceptions

Exception

GoogleCloudIntegrationsV1alphaListAuthConfigsResponse listProjectsLocationsProductsAuthConfigs(string $parent, array $optParams = [])

Lists all auth configs that match the filter. Restrict to auth configs belong to the current client only.

(authConfigs.listProjectsLocationsProductsAuthConfigs)

Parameters

string $parent

Required. The client, which owns this collection of AuthConfigs.

array $optParams

Optional parameters.

Return Value

GoogleCloudIntegrationsV1alphaListAuthConfigsResponse

Exceptions

Exception

GoogleCloudIntegrationsV1alphaAuthConfig patch(string $name, GoogleCloudIntegrationsV1alphaAuthConfig $postBody, array $optParams = [])

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. (authConfigs.patch)

Parameters

string $name

Resource name of the auth config. For more information, see Manage authentication profiles. projects/{project}/locations/{location}/authConfigs/{authConfig}.

GoogleCloudIntegrationsV1alphaAuthConfig $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudIntegrationsV1alphaAuthConfig

Exceptions

Exception