aliases

Creates, updates, deletes, gets or lists an aliases resource.

Overview

Name	aliases
Type	Resource
Id	google.apigee.aliases

Fields

The following fields are returned by SELECT queries:

organizations_environments_keystores_aliases_get

Successful response

Name	Datatype	Description
alias	string	Resource ID for this alias. Values must match the regular expression [^/]{1,255}.
certsInfo	object	Chain of certificates under this alias. (id: GoogleCloudApigeeV1Certificate)
type	string	Type of alias.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
organizations_environments_keystores_aliases_get	select	organizationsId, environmentsId, keystoresId, aliasesId		Gets an alias.
organizations_environments_keystores_aliases_create	insert	organizationsId, environmentsId, keystoresId	alias, format, ignoreExpiryValidation, _password, ignoreNewlineValidation	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.
organizations_environments_keystores_aliases_update	replace	organizationsId, environmentsId, keystoresId, aliasesId	ignoreExpiryValidation, ignoreNewlineValidation	Updates the certificate in an alias. The updated certificate must be in PEM- or DER-encoded X.509 format.
organizations_environments_keystores_aliases_delete	delete	organizationsId, environmentsId, keystoresId, aliasesId		Deletes an alias.
organizations_environments_keystores_aliases_csr	exec	organizationsId, environmentsId, keystoresId, aliasesId		Generates a PKCS #10 Certificate Signing Request for the private key in an alias.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
aliasesId	string
environmentsId	string
keystoresId	string
organizationsId	string
_password	string
alias	string
format	string
ignoreExpiryValidation	boolean
ignoreNewlineValidation	boolean

SELECT examples

organizations_environments_keystores_aliases_get

Gets an alias.

SELECT
alias,
certsInfo,
type
FROM google.apigee.aliases
WHERE organizationsId = '{{ organizationsId }}' -- required
AND environmentsId = '{{ environmentsId }}' -- required
AND keystoresId = '{{ keystoresId }}' -- required
AND aliasesId = '{{ aliasesId }}' -- required;

INSERT examples

organizations_environments_keystores_aliases_create

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.

INSERT INTO google.apigee.aliases (
data__contentType,
data__data,
data__extensions,
organizationsId,
environmentsId,
keystoresId,
alias,
format,
ignoreExpiryValidation,
_password,
ignoreNewlineValidation
)
SELECT 
'{{ contentType }}',
'{{ data }}',
'{{ extensions }}',
'{{ organizationsId }}',
'{{ environmentsId }}',
'{{ keystoresId }}',
'{{ alias }}',
'{{ format }}',
'{{ ignoreExpiryValidation }}',
'{{ _password }}',
'{{ ignoreNewlineValidation }}'
RETURNING
alias,
certsInfo,
type
;

Manifest

# Description fields are for documentation purposes
- name: aliases
  props:
    - name: organizationsId
      value: string
      description: Required parameter for the aliases resource.
    - name: environmentsId
      value: string
      description: Required parameter for the aliases resource.
    - name: keystoresId
      value: string
      description: Required parameter for the aliases resource.
    - name: contentType
      value: string
      description: >
        The HTTP Content-Type header value specifying the content type of the body.
        
    - name: data
      value: string
      description: >
        The HTTP request/response body as raw binary.
        
    - name: extensions
      value: array
      description: >
        Application specific response metadata. Must be set in the first response for streaming APIs.
        
    - name: alias
      value: string
    - name: format
      value: string
    - name: ignoreExpiryValidation
      value: boolean
    - name: _password
      value: string
    - name: ignoreNewlineValidation
      value: boolean

REPLACE examples

organizations_environments_keystores_aliases_update

Updates the certificate in an alias. The updated certificate must be in PEM- or DER-encoded X.509 format.

REPLACE google.apigee.aliases
SET 
data__contentType = '{{ contentType }}',
data__data = '{{ data }}',
data__extensions = '{{ extensions }}'
WHERE 
organizationsId = '{{ organizationsId }}' --required
AND environmentsId = '{{ environmentsId }}' --required
AND keystoresId = '{{ keystoresId }}' --required
AND aliasesId = '{{ aliasesId }}' --required
AND ignoreExpiryValidation = {{ ignoreExpiryValidation}}
AND ignoreNewlineValidation = {{ ignoreNewlineValidation}}
RETURNING
alias,
certsInfo,
type;

DELETE examples

organizations_environments_keystores_aliases_delete

Deletes an alias.

DELETE FROM google.apigee.aliases
WHERE organizationsId = '{{ organizationsId }}' --required
AND environmentsId = '{{ environmentsId }}' --required
AND keystoresId = '{{ keystoresId }}' --required
AND aliasesId = '{{ aliasesId }}' --required;

Lifecycle Methods

organizations_environments_keystores_aliases_csr

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

EXEC google.apigee.aliases.organizations_environments_keystores_aliases_csr 
@organizationsId='{{ organizationsId }}' --required, 
@environmentsId='{{ environmentsId }}' --required, 
@keystoresId='{{ keystoresId }}' --required, 
@aliasesId='{{ aliasesId }}' --required;