authorized_certificates

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

Overview

Name	authorized_certificates
Type	Resource
Id	google.appengine.authorized_certificates

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
id	string	Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly
name	string	Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly
certificateRawData	object	The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority. (id: CertificateRawData)
displayName	string	The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.
domainMappingsCount	integer (int32)	Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly
domainNames	array	Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly
expireTime	string (google-datetime)	The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly
managedCertificate	object	Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly (id: ManagedCertificate)
visibleDomainMappings	array	The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly

list

Successful response

Name	Datatype	Description
id	string	Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly
name	string	Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly
certificateRawData	object	The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority. (id: CertificateRawData)
displayName	string	The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.
domainMappingsCount	integer (int32)	Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly
domainNames	array	Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly
expireTime	string (google-datetime)	The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly
managedCertificate	object	Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly (id: ManagedCertificate)
visibleDomainMappings	array	The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, applicationsId, authorizedCertificatesId	view	Gets the specified SSL certificate.
list	select	projectsId, locationsId, applicationsId	view, pageSize, pageToken	Lists all SSL certificates the user is authorized to administer.
create	insert	projectsId, locationsId, applicationsId		Uploads the specified SSL certificate.
patch	update	projectsId, locationsId, applicationsId, authorizedCertificatesId	updateMask	Updates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update certificate_data with a new certificate. The new certificate must be applicable to the same domains as the original certificate. The certificate display_name may also be updated.
delete	delete	projectsId, locationsId, applicationsId, authorizedCertificatesId		Deletes the specified SSL certificate.

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
applicationsId	string
authorizedCertificatesId	string
locationsId	string
projectsId	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)
view	string

SELECT examples

get

Gets the specified SSL certificate.

SELECT
id,
name,
certificateRawData,
displayName,
domainMappingsCount,
domainNames,
expireTime,
managedCertificate,
visibleDomainMappings
FROM google.appengine.authorized_certificates
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND applicationsId = '{{ applicationsId }}' -- required
AND authorizedCertificatesId = '{{ authorizedCertificatesId }}' -- required
AND view = '{{ view }}';

list

Lists all SSL certificates the user is authorized to administer.

SELECT
id,
name,
certificateRawData,
displayName,
domainMappingsCount,
domainNames,
expireTime,
managedCertificate,
visibleDomainMappings
FROM google.appengine.authorized_certificates
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND applicationsId = '{{ applicationsId }}' -- required
AND view = '{{ view }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

INSERT examples

create

Uploads the specified SSL certificate.

INSERT INTO google.appengine.authorized_certificates (
data__name,
data__id,
data__displayName,
data__domainNames,
data__expireTime,
data__certificateRawData,
data__managedCertificate,
data__visibleDomainMappings,
data__domainMappingsCount,
projectsId,
locationsId,
applicationsId
)
SELECT 
'{{ name }}',
'{{ id }}',
'{{ displayName }}',
'{{ domainNames }}',
'{{ expireTime }}',
'{{ certificateRawData }}',
'{{ managedCertificate }}',
'{{ visibleDomainMappings }}',
{{ domainMappingsCount }},
'{{ projectsId }}',
'{{ locationsId }}',
'{{ applicationsId }}'
RETURNING
id,
name,
certificateRawData,
displayName,
domainMappingsCount,
domainNames,
expireTime,
managedCertificate,
visibleDomainMappings
;

Manifest

# Description fields are for documentation purposes
- name: authorized_certificates
  props:
    - name: projectsId
      value: string
      description: Required parameter for the authorized_certificates resource.
    - name: locationsId
      value: string
      description: Required parameter for the authorized_certificates resource.
    - name: applicationsId
      value: string
      description: Required parameter for the authorized_certificates resource.
    - name: name
      value: string
      description: >
        Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly
        
    - name: id
      value: string
      description: >
        Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly
        
    - name: displayName
      value: string
      description: >
        The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.
        
    - name: domainNames
      value: array
      description: >
        Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly
        
    - name: expireTime
      value: string
      description: >
        The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly
        
    - name: certificateRawData
      value: object
      description: >
        The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority.
        
    - name: managedCertificate
      value: object
      description: >
        Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly
        
    - name: visibleDomainMappings
      value: array
      description: >
        The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly
        
    - name: domainMappingsCount
      value: integer
      description: >
        Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly
        

UPDATE examples

patch

Updates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update certificate_data with a new certificate. The new certificate must be applicable to the same domains as the original certificate. The certificate display_name may also be updated.

UPDATE google.appengine.authorized_certificates
SET 
data__name = '{{ name }}',
data__id = '{{ id }}',
data__displayName = '{{ displayName }}',
data__domainNames = '{{ domainNames }}',
data__expireTime = '{{ expireTime }}',
data__certificateRawData = '{{ certificateRawData }}',
data__managedCertificate = '{{ managedCertificate }}',
data__visibleDomainMappings = '{{ visibleDomainMappings }}',
data__domainMappingsCount = {{ domainMappingsCount }}
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND applicationsId = '{{ applicationsId }}' --required
AND authorizedCertificatesId = '{{ authorizedCertificatesId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
id,
name,
certificateRawData,
displayName,
domainMappingsCount,
domainNames,
expireTime,
managedCertificate,
visibleDomainMappings;

DELETE examples

delete

Deletes the specified SSL certificate.

DELETE FROM google.appengine.authorized_certificates
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND applicationsId = '{{ applicationsId }}' --required
AND authorizedCertificatesId = '{{ authorizedCertificatesId }}' --required;