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
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- View and manage your data across Google Cloud Platform services
Input
This building block consumes 16 input parameters
| Name | Format | Description |
|---|---|---|
appsId Required |
STRING |
Part of |
authorizedCertificatesId Required |
STRING |
Part of |
updateMask |
ANY |
Standard field mask for the set of fields to be updated. Updates are only supported on the certificate_raw_data and display_name fields |
visibleDomainMappings[] |
STRING |
|
expireTime |
ANY |
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 |
STRING |
Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly |
domainMappingsCount |
INTEGER |
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[] |
STRING |
|
id |
STRING |
Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly |
displayName |
STRING |
The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate |
managedCertificate |
OBJECT |
A certificate managed by App Engine |
managedCertificate.lastRenewalTime |
ANY |
Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly |
managedCertificate.status |
ENUMERATION |
Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly |
certificateRawData |
OBJECT |
An SSL certificate obtained from a certificate authority |
certificateRawData.publicCertificate |
STRING |
PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: -----BEGIN CERTIFICATE----- <certificate_value> -----END CERTIFICATE----- |
certificateRawData.privateKey |
STRING |
Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: -----BEGIN RSA PRIVATE KEY----- <unencrypted_key_value> -----END RSA PRIVATE KEY-----@InputOnly |
= Parameter name
= Format
|
appsId STRING Required Part of |
|
authorizedCertificatesId STRING Required Part of |
|
updateMask ANY Standard field mask for the set of fields to be updated. Updates are only supported on the certificate_raw_data and display_name fields |
|
visibleDomainMappings[] STRING |
|
expireTime ANY 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 STRING Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly |
|
domainMappingsCount INTEGER 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[] STRING |
|
id STRING Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly |
|
displayName STRING The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate |
|
managedCertificate OBJECT A certificate managed by App Engine |
|
managedCertificate.lastRenewalTime ANY Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly |
|
managedCertificate.status ENUMERATION Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly |
|
certificateRawData OBJECT An SSL certificate obtained from a certificate authority |
|
certificateRawData.publicCertificate STRING PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: -----BEGIN CERTIFICATE----- <certificate_value> -----END CERTIFICATE----- |
|
certificateRawData.privateKey STRING Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: -----BEGIN RSA PRIVATE KEY----- <unencrypted_key_value> -----END RSA PRIVATE KEY-----@InputOnly |
Output
This building block provides 13 output parameters
| Name | Format | Description |
|---|---|---|
visibleDomainMappings[] |
STRING |
|
expireTime |
ANY |
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 |
STRING |
Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly |
domainMappingsCount |
INTEGER |
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[] |
STRING |
|
id |
STRING |
Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly |
displayName |
STRING |
The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate |
managedCertificate |
OBJECT |
A certificate managed by App Engine |
managedCertificate.lastRenewalTime |
ANY |
Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly |
managedCertificate.status |
ENUMERATION |
Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly |
certificateRawData |
OBJECT |
An SSL certificate obtained from a certificate authority |
certificateRawData.publicCertificate |
STRING |
PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: -----BEGIN CERTIFICATE----- <certificate_value> -----END CERTIFICATE----- |
certificateRawData.privateKey |
STRING |
Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: -----BEGIN RSA PRIVATE KEY----- <unencrypted_key_value> -----END RSA PRIVATE KEY-----@InputOnly |
= Parameter name
= Format
|
visibleDomainMappings[] STRING |
|
expireTime ANY 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 STRING Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly |
|
domainMappingsCount INTEGER 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[] STRING |
|
id STRING Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly |
|
displayName STRING The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate |
|
managedCertificate OBJECT A certificate managed by App Engine |
|
managedCertificate.lastRenewalTime ANY Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly |
|
managedCertificate.status ENUMERATION Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly |
|
certificateRawData OBJECT An SSL certificate obtained from a certificate authority |
|
certificateRawData.publicCertificate STRING PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: -----BEGIN CERTIFICATE----- <certificate_value> -----END CERTIFICATE----- |
|
certificateRawData.privateKey STRING Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: -----BEGIN RSA PRIVATE KEY----- <unencrypted_key_value> -----END RSA PRIVATE KEY-----@InputOnly |