| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="androidpublisher_v3.html">Google Play Android Developer API</a> . <a href="androidpublisher_v3.appsigning.html">appsigning</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#enrollApp">enrollApp(name, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Enrolls an app in Play App Signing using a self-hosted Google Cloud KMS key. Warning: Do not use this method for standard Play App Signing enrollment. * Standard enrollment with Google-generated or Google-managed keys cannot be done via API. * This advanced API is strictly for enterprise organizations with mandatory compliance, regulatory, or policy requirements to retain key custody in an external Google Cloud KMS instance. * Prerequisites: Requires an active, properly configured Google Cloud KMS key with appropriate IAM permissions granted to Google Play before calling this method. See Help Center: https://support.google.com/googleplay/android-developer/answer/9842756</p> |
| <p class="toc_element"> |
| <code><a href="#rotateAppSigningKey">rotateAppSigningKey(name, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Rotates an app's signing key to a new self-hosted Google Cloud KMS key. Warning: This method only applies to apps enrolled with self-hosted Cloud KMS keys. For apps using standard Google-managed Play App Signing, key rotation requests must be initiated through the Google Play Console UI. See Help Center: https://support.google.com/googleplay/android-developer/answer/9842756</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="enrollApp">enrollApp(name, body=None, x__xgafv=None)</code> |
| <pre>Enrolls an app in Play App Signing using a self-hosted Google Cloud KMS key. Warning: Do not use this method for standard Play App Signing enrollment. * Standard enrollment with Google-generated or Google-managed keys cannot be done via API. * This advanced API is strictly for enterprise organizations with mandatory compliance, regulatory, or policy requirements to retain key custody in an external Google Cloud KMS instance. * Prerequisites: Requires an active, properly configured Google Cloud KMS key with appropriate IAM permissions granted to Google Play before calling this method. See Help Center: https://support.google.com/googleplay/android-developer/answer/9842756 |
| |
| Args: |
| name: string, Required. Either package name or app ID of the app enrolling in Play Signing. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Request to enroll an app into Play App Signing using a self-hosted Cloud KMS key. |
| "enrollExistingApp": { # Enroll an existing app into Play signing. # Enrolls an existing app into Play signing using an external Cloud KMS key. |
| "cloudKmsKey": { # Reference to a private key hosted in developer-managed Google Cloud KMS. # Required. Self-hosted key. Once enrolled, this key will be used to sign your app. |
| "cryptoKeyVersionResource": "A String", # Required. Resource identifier of the private key hosted in Google Cloud KMS. The Google Play service account must be granted Decrypt and Sign permissions on this resource. Format: projects//locations//keyRings//cryptoKeys//cryptoKeyVersions/ |
| }, |
| }, |
| "enrollNewApp": { # Enroll a new app into Play signing. # Changes the signing key of a new app to an external Cloud KMS key. The app must not have published to Open testing or Production tracks. |
| "cloudKmsKeyAndCert": { # Cloud KMS key and the certificate associated with the key. # Required. Self-hosted key. Once enrolled, this key will be used to sign your app. |
| "cloudKmsKey": { # Reference to a private key hosted in developer-managed Google Cloud KMS. # Required. Cloud KMS key. |
| "cryptoKeyVersionResource": "A String", # Required. Resource identifier of the private key hosted in Google Cloud KMS. The Google Play service account must be granted Decrypt and Sign permissions on this resource. Format: projects//locations//keyRings//cryptoKeys//cryptoKeyVersions/ |
| }, |
| "pemCertificate": "A String", # Required. Certificate associated with the key. The bytes must contain the certificate in PEM format. |
| }, |
| }, |
| "pemUploadCertificate": "A String", # The certificate associated with the upload key, in PEM format. |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response to enroll an app into Play signing. |
| "signingCertificate": { # Hash digests of a certificate. # The signing certificate hashes for the app. Always set. |
| "certificateHashMd5": "A String", # Hex-encoded MD5 hash of the certificate. example: `43:51:43:A1:B5:FC:8B:B7:0A:3A:A9:B1:0F:66:73:A8` |
| "certificateHashSha1": "A String", # Hex-encoded SHA1 hash of the certificate. example: `86:61:97:1A:D5:EF:E5:74:1E:A7:5B:84:7C:68:37:65:CD:94:16:DE` |
| "certificateHashSha256": "A String", # Hex-encoded SHA256 hash of the certificate. example: `94:49:C7:F3:A9:3C:F0:C5:5A:67:5D:DF:1C:83:73:2D:87:D5:62:55:E7:0B:15:0D:9E:6F:3C:F8:63:BB:7F:C1` |
| }, |
| "uploadCertificate": { # Hash digests of a certificate. # The upload certificate hashes for the app. Set iff pem_upload_certificate was set in the request. |
| "certificateHashMd5": "A String", # Hex-encoded MD5 hash of the certificate. example: `43:51:43:A1:B5:FC:8B:B7:0A:3A:A9:B1:0F:66:73:A8` |
| "certificateHashSha1": "A String", # Hex-encoded SHA1 hash of the certificate. example: `86:61:97:1A:D5:EF:E5:74:1E:A7:5B:84:7C:68:37:65:CD:94:16:DE` |
| "certificateHashSha256": "A String", # Hex-encoded SHA256 hash of the certificate. example: `94:49:C7:F3:A9:3C:F0:C5:5A:67:5D:DF:1C:83:73:2D:87:D5:62:55:E7:0B:15:0D:9E:6F:3C:F8:63:BB:7F:C1` |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="rotateAppSigningKey">rotateAppSigningKey(name, body=None, x__xgafv=None)</code> |
| <pre>Rotates an app's signing key to a new self-hosted Google Cloud KMS key. Warning: This method only applies to apps enrolled with self-hosted Cloud KMS keys. For apps using standard Google-managed Play App Signing, key rotation requests must be initiated through the Google Play Console UI. See Help Center: https://support.google.com/googleplay/android-developer/answer/9842756 |
| |
| Args: |
| name: string, Required. Either package name or app ID of the app rotating the signing key. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Request to rotate an app's signing key. |
| "keyRotationReason": "A String", # Required. Reason for rotating the app key. |
| "rotatedCloudKmsKey": { # Message representing rotated Cloud KMS key. Consists of the Cloud KMS key and its associated proof of rotation. # Required. Self-hosted Cloud KMS key. |
| "cloudKmsKeyAndCert": { # Cloud KMS key and the certificate associated with the key. # Required. Cloud KMS key and the certificate associated with the key. |
| "cloudKmsKey": { # Reference to a private key hosted in developer-managed Google Cloud KMS. # Required. Cloud KMS key. |
| "cryptoKeyVersionResource": "A String", # Required. Resource identifier of the private key hosted in Google Cloud KMS. The Google Play service account must be granted Decrypt and Sign permissions on this resource. Format: projects//locations//keyRings//cryptoKeys//cryptoKeyVersions/ |
| }, |
| "pemCertificate": "A String", # Required. Certificate associated with the key. The bytes must contain the certificate in PEM format. |
| }, |
| "signingCertificateLineage": "A String", # Required. Proof-of-rotation. See [creating signing certificate lineages](https://developer.android.com/studio/command-line/apksigner#rotate_signing_keys_2). |
| }, |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response to rotate an app's signing key. |
| "rotatedKeyCertificate": { # Hash digests of a certificate. # The rotated key certificate hashes for the app. Always set. |
| "certificateHashMd5": "A String", # Hex-encoded MD5 hash of the certificate. example: `43:51:43:A1:B5:FC:8B:B7:0A:3A:A9:B1:0F:66:73:A8` |
| "certificateHashSha1": "A String", # Hex-encoded SHA1 hash of the certificate. example: `86:61:97:1A:D5:EF:E5:74:1E:A7:5B:84:7C:68:37:65:CD:94:16:DE` |
| "certificateHashSha256": "A String", # Hex-encoded SHA256 hash of the certificate. example: `94:49:C7:F3:A9:3C:F0:C5:5A:67:5D:DF:1C:83:73:2D:87:D5:62:55:E7:0B:15:0D:9E:6F:3C:F8:63:BB:7F:C1` |
| }, |
| }</pre> |
| </div> |
| |
| </body></html> |
