class OrganizationsEnvironmentsKeystoresAliases extends Resource (View source)

The "aliases" collection of methods.

Typical usage is:

 $apigeeService = new Google\Service\Apigee(...);
 $aliases = $apigeeService->organizations_environments_keystores_aliases;

Methods

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

Creates an alias from a key/certificate pair. The structure of the request is controlled by the format query parameter: - keycertfile - Separate PEM- encoded key and certificate files are uploaded. Set Content-Type: multipart/form-data and include the keyFile, certFile, and password (if keys are encrypted) fields in the request body. If uploading to a truststore, omit keyFile. - pkcs12 - A PKCS12 file is uploaded. Set Content-Type: multipart/form-data, provide the file in the file field, and include the password field if the file is encrypted in the request body. - selfsignedcert - A new private key and certificate are generated.

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

Generates a PKCS #10 Certificate Signing Request for the private key in an alias. (aliases.csr)

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

Deletes an alias. (aliases.delete)

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

Gets an alias. (aliases.get)

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

Gets the certificate from an alias in PEM-encoded form.

update(string $name, GoogleApiHttpBody $postBody, array $optParams = [])

Updates the certificate in an alias. (aliases.update)

Details

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

Creates an alias from a key/certificate pair. The structure of the request is controlled by the format query parameter: - keycertfile - Separate PEM- encoded key and certificate files are uploaded. Set Content-Type: multipart/form-data and include the keyFile, certFile, and password (if keys are encrypted) fields in the request body. If uploading to a truststore, omit keyFile. - pkcs12 - A PKCS12 file is uploaded. Set Content-Type: multipart/form-data, provide the file in the file field, and include the password field if the file is encrypted in the request body. - selfsignedcert - A new private key and certificate are generated.

Set Content-Type: application/json and include CertificateGenerationSpec in the request body. (aliases.create)

Parameters

string $parent

Required. Name of the keystore. Use the following format in your request: organizations/{org}/environments/{env}/keystores/{keystore}.

GoogleApiHttpBody $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1Alias

Exceptions

Exception

GoogleApiHttpBody csr(string $name, array $optParams = [])

Generates a PKCS #10 Certificate Signing Request for the private key in an alias. (aliases.csr)

Parameters

string $name

Required. Name of the alias. Use the following format in your request: organizations/{org}/environments/{env}/keystores/{keystore}/al iases/{alias}.

array $optParams

Optional parameters.

Return Value

GoogleApiHttpBody

Exceptions

Exception

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

Deletes an alias. (aliases.delete)

Parameters

string $name

Required. Name of the alias. Use the following format in your request: organizations/{org}/environments/{env}/keystores/{keystore}/al iases/{alias}.

array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1Alias

Exceptions

Exception

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

Gets an alias. (aliases.get)

Parameters

string $name

Required. Name of the alias. Use the following format in your request: organizations/{org}/environments/{env}/keystores/{keystore}/al iases/{alias}.

array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1Alias

Exceptions

Exception

GoogleApiHttpBody getCertificate(string $name, array $optParams = [])

Gets the certificate from an alias in PEM-encoded form.

(aliases.getCertificate)

Parameters

string $name

Required. Name of the alias. Use the following format in your request: organizations/{org}/environments/{env}/keystores/{keystore}/al iases/{alias}.

array $optParams

Optional parameters.

Return Value

GoogleApiHttpBody

Exceptions

Exception

GoogleCloudApigeeV1Alias update(string $name, GoogleApiHttpBody $postBody, array $optParams = [])

Updates the certificate in an alias. (aliases.update)

Parameters

string $name

Required. Name of the alias. Use the following format in your request: organizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}

GoogleApiHttpBody $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1Alias

Exceptions

Exception