Debian Codegraph @

docs/dyn/cloudkms_v1.folders.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="cloudkms_v1.html">Cloud Key Management Service (KMS) API</a> . <a href="cloudkms_v1.folders.html">folders</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#getAutokeyConfig">getAutokeyConfig(name, x__xgafv=None)</a></code></p>
82 <p class="firstline">Returns the AutokeyConfig for a folder or project.</p>
83 <p class="toc_element">
84 <code><a href="#getKajPolicyConfig">getKajPolicyConfig(name, x__xgafv=None)</a></code></p>
85 <p class="firstline">Gets the KeyAccessJustificationsPolicyConfig for a given organization, folder, or project.</p>
86 <p class="toc_element">
87 <code><a href="#updateAutokeyConfig">updateAutokeyConfig(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Updates the AutokeyConfig for a folder or a project. The caller must have both `cloudkms.autokeyConfigs.update` permission on the parent folder and `cloudkms.cryptoKeys.setIamPolicy` permission on the provided key project. A KeyHandle creation in the folder's descendant projects will use this configuration to determine where to create the resulting CryptoKey.</p>
89 <p class="toc_element">
90 <code><a href="#updateKajPolicyConfig">updateKajPolicyConfig(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Updates the KeyAccessJustificationsPolicyConfig for a given organization, folder, or project.</p>
92 <h3>Method Details</h3>
93 <div class="method">
94 <code class="details" id="close">close()</code>
95 <pre>Close httplib2 connections.</pre>
96 </div>
97
98 <div class="method">
99 <code class="details" id="getAutokeyConfig">getAutokeyConfig(name, x__xgafv=None)</code>
100 <pre>Returns the AutokeyConfig for a folder or project.
101
102 Args:
103 name: string, Required. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig`, `projects/{PROJECT_NUMBER}/autokeyConfig`, or `projects/{PROJECT_ID}/autokeyConfig`. (required)
104 x__xgafv: string, V1 error format.
105 Allowed values
106 1 - v1 error format
107 2 - v2 error format
108
109 Returns:
110 An object of the form:
111
112 { # Cloud KMS Autokey configuration for a folder.
113 &quot;etag&quot;: &quot;A String&quot;, # Optional. A checksum computed by the server based on the value of other fields. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The request will be rejected with an ABORTED error on a mismatched etag.
114 &quot;keyProject&quot;: &quot;A String&quot;, # Optional. Name of the key project, e.g. `projects/{PROJECT_ID}` or `projects/{PROJECT_NUMBER}`, where Cloud KMS Autokey will provision a new CryptoKey when a KeyHandle is created. On UpdateAutokeyConfig, the caller will require `cloudkms.cryptoKeys.setIamPolicy` permission on this key project. Once configured, for Cloud KMS Autokey to function properly, this key project must have the Cloud KMS API activated and the Cloud KMS Service Agent for this key project must be granted the `cloudkms.admin` role (or pertinent permissions). A request with an empty key project field will clear the configuration.
115 &quot;keyProjectResolutionMode&quot;: &quot;A String&quot;, # Optional. KeyProjectResolutionMode for the AutokeyConfig. Valid values are `DEDICATED_KEY_PROJECT`, `RESOURCE_PROJECT`, or `DISABLED`.
116 &quot;name&quot;: &quot;A String&quot;, # Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig`, `projects/{PROJECT_NUMBER}/autokeyConfig`, or `projects/{PROJECT_ID}/autokeyConfig`.
117 &quot;state&quot;: &quot;A String&quot;, # Output only. The state for the AutokeyConfig.
118 }</pre>
119 </div>
120
121 <div class="method">
122 <code class="details" id="getKajPolicyConfig">getKajPolicyConfig(name, x__xgafv=None)</code>
123 <pre>Gets the KeyAccessJustificationsPolicyConfig for a given organization, folder, or project.
124
125 Args:
126 name: string, Required. Specifies the name of the KeyAccessJustificationsPolicyConfig to get. (required)
127 x__xgafv: string, V1 error format.
128 Allowed values
129 1 - v1 error format
130 2 - v2 error format
131
132 Returns:
133 An object of the form:
134
135 { # Represents a singleton configuration for Key Access Justifications policies.
136 &quot;defaultKeyAccessJustificationPolicy&quot;: { # A KeyAccessJustificationsPolicy specifies zero or more allowed AccessReason values for encrypt, decrypt, and sign operations on a CryptoKey or KeyAccessJustificationsPolicyConfig (the default Key Access Justifications policy). # Optional. Specifies the default key access justifications (KAJ) 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. If this field is unset, or is set but contains an empty allowed_access_reasons list, no default Key Access Justifications (KAJ) policy configuration is active. In this scenario, all newly created keys will default to an &quot;allow-all&quot; policy.
137 &quot;allowedAccessReasons&quot;: [ # The list of allowed reasons for access to a CryptoKey. Note that empty allowed_access_reasons has a different meaning depending on where this message appears. If this is under KeyAccessJustificationsPolicyConfig, it means allow-all. If this is under CryptoKey, it means deny-all.
138 &quot;A String&quot;,
139 ],
140 },
141 &quot;defaultPolicyAvailable&quot;: True or False, # Output only. Indicates whether this parent resource is available to default policy feature. Please consult [the prerequisite of default policy feature](https://cloud.google.com/assured-workloads/key-access-justifications/docs/set-default-policy#before) for more details.
142 &quot;name&quot;: &quot;A String&quot;, # Identifier. Represents the resource name for this KeyAccessJustificationsPolicyConfig in the format of &quot;{organizations|folders|projects}/*/kajPolicyConfig&quot;.
143 }</pre>
144 </div>
145
146 <div class="method">
147 <code class="details" id="updateAutokeyConfig">updateAutokeyConfig(name, body=None, updateMask=None, x__xgafv=None)</code>
148 <pre>Updates the AutokeyConfig for a folder or a project. The caller must have both `cloudkms.autokeyConfigs.update` permission on the parent folder and `cloudkms.cryptoKeys.setIamPolicy` permission on the provided key project. A KeyHandle creation in the folder&#x27;s descendant projects will use this configuration to determine where to create the resulting CryptoKey.
149
150 Args:
151 name: string, Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig`, `projects/{PROJECT_NUMBER}/autokeyConfig`, or `projects/{PROJECT_ID}/autokeyConfig`. (required)
152 body: object, The request body.
153 The object takes the form of:
154
155 { # Cloud KMS Autokey configuration for a folder.
156 &quot;etag&quot;: &quot;A String&quot;, # Optional. A checksum computed by the server based on the value of other fields. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The request will be rejected with an ABORTED error on a mismatched etag.
157 &quot;keyProject&quot;: &quot;A String&quot;, # Optional. Name of the key project, e.g. `projects/{PROJECT_ID}` or `projects/{PROJECT_NUMBER}`, where Cloud KMS Autokey will provision a new CryptoKey when a KeyHandle is created. On UpdateAutokeyConfig, the caller will require `cloudkms.cryptoKeys.setIamPolicy` permission on this key project. Once configured, for Cloud KMS Autokey to function properly, this key project must have the Cloud KMS API activated and the Cloud KMS Service Agent for this key project must be granted the `cloudkms.admin` role (or pertinent permissions). A request with an empty key project field will clear the configuration.
158 &quot;keyProjectResolutionMode&quot;: &quot;A String&quot;, # Optional. KeyProjectResolutionMode for the AutokeyConfig. Valid values are `DEDICATED_KEY_PROJECT`, `RESOURCE_PROJECT`, or `DISABLED`.
159 &quot;name&quot;: &quot;A String&quot;, # Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig`, `projects/{PROJECT_NUMBER}/autokeyConfig`, or `projects/{PROJECT_ID}/autokeyConfig`.
160 &quot;state&quot;: &quot;A String&quot;, # Output only. The state for the AutokeyConfig.
161 }
162
163 updateMask: string, Required. Masks which fields of the AutokeyConfig to update, e.g. `keyProject`.
164 x__xgafv: string, V1 error format.
165 Allowed values
166 1 - v1 error format
167 2 - v2 error format
168
169 Returns:
170 An object of the form:
171
172 { # Cloud KMS Autokey configuration for a folder.
173 &quot;etag&quot;: &quot;A String&quot;, # Optional. A checksum computed by the server based on the value of other fields. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The request will be rejected with an ABORTED error on a mismatched etag.
174 &quot;keyProject&quot;: &quot;A String&quot;, # Optional. Name of the key project, e.g. `projects/{PROJECT_ID}` or `projects/{PROJECT_NUMBER}`, where Cloud KMS Autokey will provision a new CryptoKey when a KeyHandle is created. On UpdateAutokeyConfig, the caller will require `cloudkms.cryptoKeys.setIamPolicy` permission on this key project. Once configured, for Cloud KMS Autokey to function properly, this key project must have the Cloud KMS API activated and the Cloud KMS Service Agent for this key project must be granted the `cloudkms.admin` role (or pertinent permissions). A request with an empty key project field will clear the configuration.
175 &quot;keyProjectResolutionMode&quot;: &quot;A String&quot;, # Optional. KeyProjectResolutionMode for the AutokeyConfig. Valid values are `DEDICATED_KEY_PROJECT`, `RESOURCE_PROJECT`, or `DISABLED`.
176 &quot;name&quot;: &quot;A String&quot;, # Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig`, `projects/{PROJECT_NUMBER}/autokeyConfig`, or `projects/{PROJECT_ID}/autokeyConfig`.
177 &quot;state&quot;: &quot;A String&quot;, # Output only. The state for the AutokeyConfig.
178 }</pre>
179 </div>
180
181 <div class="method">
182 <code class="details" id="updateKajPolicyConfig">updateKajPolicyConfig(name, body=None, updateMask=None, x__xgafv=None)</code>
183 <pre>Updates the KeyAccessJustificationsPolicyConfig for a given organization, folder, or project.
184
185 Args:
186 name: string, Identifier. Represents the resource name for this KeyAccessJustificationsPolicyConfig in the format of &quot;{organizations|folders|projects}/*/kajPolicyConfig&quot;. (required)
187 body: object, The request body.
188 The object takes the form of:
189
190 { # Represents a singleton configuration for Key Access Justifications policies.
191 &quot;defaultKeyAccessJustificationPolicy&quot;: { # A KeyAccessJustificationsPolicy specifies zero or more allowed AccessReason values for encrypt, decrypt, and sign operations on a CryptoKey or KeyAccessJustificationsPolicyConfig (the default Key Access Justifications policy). # Optional. Specifies the default key access justifications (KAJ) 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. If this field is unset, or is set but contains an empty allowed_access_reasons list, no default Key Access Justifications (KAJ) policy configuration is active. In this scenario, all newly created keys will default to an &quot;allow-all&quot; policy.
192 &quot;allowedAccessReasons&quot;: [ # The list of allowed reasons for access to a CryptoKey. Note that empty allowed_access_reasons has a different meaning depending on where this message appears. If this is under KeyAccessJustificationsPolicyConfig, it means allow-all. If this is under CryptoKey, it means deny-all.
193 &quot;A String&quot;,
194 ],
195 },
196 &quot;defaultPolicyAvailable&quot;: True or False, # Output only. Indicates whether this parent resource is available to default policy feature. Please consult [the prerequisite of default policy feature](https://cloud.google.com/assured-workloads/key-access-justifications/docs/set-default-policy#before) for more details.
197 &quot;name&quot;: &quot;A String&quot;, # Identifier. Represents the resource name for this KeyAccessJustificationsPolicyConfig in the format of &quot;{organizations|folders|projects}/*/kajPolicyConfig&quot;.
198 }
199
200 updateMask: string, Optional. Specifies the list of fields to update.
201 x__xgafv: string, V1 error format.
202 Allowed values
203 1 - v1 error format
204 2 - v2 error format
205
206 Returns:
207 An object of the form:
208
209 { # Represents a singleton configuration for Key Access Justifications policies.
210 &quot;defaultKeyAccessJustificationPolicy&quot;: { # A KeyAccessJustificationsPolicy specifies zero or more allowed AccessReason values for encrypt, decrypt, and sign operations on a CryptoKey or KeyAccessJustificationsPolicyConfig (the default Key Access Justifications policy). # Optional. Specifies the default key access justifications (KAJ) 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. If this field is unset, or is set but contains an empty allowed_access_reasons list, no default Key Access Justifications (KAJ) policy configuration is active. In this scenario, all newly created keys will default to an &quot;allow-all&quot; policy.
211 &quot;allowedAccessReasons&quot;: [ # The list of allowed reasons for access to a CryptoKey. Note that empty allowed_access_reasons has a different meaning depending on where this message appears. If this is under KeyAccessJustificationsPolicyConfig, it means allow-all. If this is under CryptoKey, it means deny-all.
212 &quot;A String&quot;,
213 ],
214 },
215 &quot;defaultPolicyAvailable&quot;: True or False, # Output only. Indicates whether this parent resource is available to default policy feature. Please consult [the prerequisite of default policy feature](https://cloud.google.com/assured-workloads/key-access-justifications/docs/set-default-policy#before) for more details.
216 &quot;name&quot;: &quot;A String&quot;, # Identifier. Represents the resource name for this KeyAccessJustificationsPolicyConfig in the format of &quot;{organizations|folders|projects}/*/kajPolicyConfig&quot;.
217 }</pre>
218 </div>
219
220 </body></html>