| <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="cloudkms_v1.html">Cloud Key Management Service (KMS) API</a> . <a href="cloudkms_v1.projects.html">projects</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="cloudkms_v1.projects.locations.html">locations()</a></code> |
| </p> |
| <p class="firstline">Returns the locations Resource.</p> |
| |
| <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="#getKajPolicyConfig">getKajPolicyConfig(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets the KeyAccessJustificationsPolicyConfig for a given organization/folder/projects.</p> |
| <p class="toc_element"> |
| <code><a href="#showEffectiveAutokeyConfig">showEffectiveAutokeyConfig(parent, x__xgafv=None)</a></code></p> |
| <p class="firstline">Returns the effective Cloud KMS Autokey configuration for a given project.</p> |
| <p class="toc_element"> |
| <code><a href="#showEffectiveKeyAccessJustificationsEnrollmentConfig">showEffectiveKeyAccessJustificationsEnrollmentConfig(project, x__xgafv=None)</a></code></p> |
| <p class="firstline">Returns the KeyAccessJustificationsEnrollmentConfig of the resource closest to the given project in hierarchy.</p> |
| <p class="toc_element"> |
| <code><a href="#showEffectiveKeyAccessJustificationsPolicyConfig">showEffectiveKeyAccessJustificationsPolicyConfig(project, x__xgafv=None)</a></code></p> |
| <p class="firstline">Returns the KeyAccessJustificationsPolicyConfig of the resource closest to the given project in hierarchy.</p> |
| <p class="toc_element"> |
| <code><a href="#updateKajPolicyConfig">updateKajPolicyConfig(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Updates the KeyAccessJustificationsPolicyConfig for a given organization/folder/projects.</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="getKajPolicyConfig">getKajPolicyConfig(name, x__xgafv=None)</code> |
| <pre>Gets the KeyAccessJustificationsPolicyConfig for a given organization/folder/projects. |
| |
| Args: |
| name: string, Required. The name of the KeyAccessJustificationsPolicyConfig to get. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A singleton configuration for Key Access Justifications policies. |
| "defaultKeyAccessJustificationPolicy": { # A KeyAccessJustificationsPolicy specifies zero or more allowed AccessReason values for encrypt, decrypt, and sign operations on a CryptoKey. # Optional. The default key access justification policy used when a CryptoKey is created in this folder. This is only used when a Key Access Justifications policy is not provided in the CreateCryptoKeyRequest. This overrides any default policies in its ancestry. |
| "allowedAccessReasons": [ # The list of allowed reasons for access to a CryptoKey. Zero allowed access reasons means all encrypt, decrypt, and sign operations for the CryptoKey associated with this policy will fail. |
| "A String", |
| ], |
| }, |
| "name": "A String", # Identifier. The resource name for this KeyAccessJustificationsPolicyConfig in the format of "{organizations|folders|projects}/*/kajPolicyConfig". |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="showEffectiveAutokeyConfig">showEffectiveAutokeyConfig(parent, x__xgafv=None)</code> |
| <pre>Returns the effective Cloud KMS Autokey configuration for a given project. |
| |
| Args: |
| parent: string, Required. Name of the resource project to the show effective Cloud KMS Autokey configuration for. This may be helpful for interrogating the effect of nested folder configurations on a given resource project. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response message for ShowEffectiveAutokeyConfig. |
| "keyProject": "A String", # Name of the key project configured in the resource project's folder ancestry. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="showEffectiveKeyAccessJustificationsEnrollmentConfig">showEffectiveKeyAccessJustificationsEnrollmentConfig(project, x__xgafv=None)</code> |
| <pre>Returns the KeyAccessJustificationsEnrollmentConfig of the resource closest to the given project in hierarchy. |
| |
| Args: |
| project: string, Required. The number or id of the project to get the effective KeyAccessJustificationsEnrollmentConfig for. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response message for KeyAccessJustificationsConfig.ShowEffectiveKeyAccessJustificationsEnrollmentConfig |
| "externalConfig": { # The configuration of a protection level for a project's Key Access Justifications enrollment. # The effective KeyAccessJustificationsEnrollmentConfig for external keys. |
| "auditLogging": True or False, # Whether the project has KAJ logging enabled. |
| "policyEnforcement": True or False, # Whether the project is enrolled in KAJ policy enforcement. |
| }, |
| "hardwareConfig": { # The configuration of a protection level for a project's Key Access Justifications enrollment. # The effective KeyAccessJustificationsEnrollmentConfig for hardware keys. |
| "auditLogging": True or False, # Whether the project has KAJ logging enabled. |
| "policyEnforcement": True or False, # Whether the project is enrolled in KAJ policy enforcement. |
| }, |
| "softwareConfig": { # The configuration of a protection level for a project's Key Access Justifications enrollment. # The effective KeyAccessJustificationsEnrollmentConfig for software keys. |
| "auditLogging": True or False, # Whether the project has KAJ logging enabled. |
| "policyEnforcement": True or False, # Whether the project is enrolled in KAJ policy enforcement. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="showEffectiveKeyAccessJustificationsPolicyConfig">showEffectiveKeyAccessJustificationsPolicyConfig(project, x__xgafv=None)</code> |
| <pre>Returns the KeyAccessJustificationsPolicyConfig of the resource closest to the given project in hierarchy. |
| |
| Args: |
| project: string, Required. The number or id of the project to get the effective KeyAccessJustificationsPolicyConfig. In the format of "projects/{|}" (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response message for KeyAccessJustificationsConfig.ShowEffectiveKeyAccessJustificationsPolicyConfig. |
| "effectiveKajPolicy": { # A singleton configuration for Key Access Justifications policies. # The effective KeyAccessJustificationsPolicyConfig. |
| "defaultKeyAccessJustificationPolicy": { # A KeyAccessJustificationsPolicy specifies zero or more allowed AccessReason values for encrypt, decrypt, and sign operations on a CryptoKey. # Optional. The default key access justification policy used when a CryptoKey is created in this folder. This is only used when a Key Access Justifications policy is not provided in the CreateCryptoKeyRequest. This overrides any default policies in its ancestry. |
| "allowedAccessReasons": [ # The list of allowed reasons for access to a CryptoKey. Zero allowed access reasons means all encrypt, decrypt, and sign operations for the CryptoKey associated with this policy will fail. |
| "A String", |
| ], |
| }, |
| "name": "A String", # Identifier. The resource name for this KeyAccessJustificationsPolicyConfig in the format of "{organizations|folders|projects}/*/kajPolicyConfig". |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="updateKajPolicyConfig">updateKajPolicyConfig(name, body=None, updateMask=None, x__xgafv=None)</code> |
| <pre>Updates the KeyAccessJustificationsPolicyConfig for a given organization/folder/projects. |
| |
| Args: |
| name: string, Identifier. The resource name for this KeyAccessJustificationsPolicyConfig in the format of "{organizations|folders|projects}/*/kajPolicyConfig". (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # A singleton configuration for Key Access Justifications policies. |
| "defaultKeyAccessJustificationPolicy": { # A KeyAccessJustificationsPolicy specifies zero or more allowed AccessReason values for encrypt, decrypt, and sign operations on a CryptoKey. # Optional. The default key access justification policy used when a CryptoKey is created in this folder. This is only used when a Key Access Justifications policy is not provided in the CreateCryptoKeyRequest. This overrides any default policies in its ancestry. |
| "allowedAccessReasons": [ # The list of allowed reasons for access to a CryptoKey. Zero allowed access reasons means all encrypt, decrypt, and sign operations for the CryptoKey associated with this policy will fail. |
| "A String", |
| ], |
| }, |
| "name": "A String", # Identifier. The resource name for this KeyAccessJustificationsPolicyConfig in the format of "{organizations|folders|projects}/*/kajPolicyConfig". |
| } |
| |
| updateMask: string, Optional. The list of fields to update. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A singleton configuration for Key Access Justifications policies. |
| "defaultKeyAccessJustificationPolicy": { # A KeyAccessJustificationsPolicy specifies zero or more allowed AccessReason values for encrypt, decrypt, and sign operations on a CryptoKey. # Optional. The default key access justification policy used when a CryptoKey is created in this folder. This is only used when a Key Access Justifications policy is not provided in the CreateCryptoKeyRequest. This overrides any default policies in its ancestry. |
| "allowedAccessReasons": [ # The list of allowed reasons for access to a CryptoKey. Zero allowed access reasons means all encrypt, decrypt, and sign operations for the CryptoKey associated with this policy will fail. |
| "A String", |
| ], |
| }, |
| "name": "A String", # Identifier. The resource name for this KeyAccessJustificationsPolicyConfig in the format of "{organizations|folders|projects}/*/kajPolicyConfig". |
| }</pre> |
| </div> |
| |
| </body></html> |
