-
Notifications
You must be signed in to change notification settings - Fork 2.4k
/
gmail_v1.users.settings.cse.keypairs.html
379 lines (330 loc) 路 24.4 KB
/
gmail_v1.users.settings.cse.keypairs.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
<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="gmail_v1.html">Gmail API</a> . <a href="gmail_v1.users.html">users</a> . <a href="gmail_v1.users.settings.html">settings</a> . <a href="gmail_v1.users.settings.cse.html">cse</a> . <a href="gmail_v1.users.settings.cse.keypairs.html">keypairs</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="#create">create(userId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates and uploads a client-side encryption S/MIME public key certificate chain and private key metadata for the authenticated user.</p>
<p class="toc_element">
<code><a href="#disable">disable(userId, keyPairId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Turns off a client-side encryption key pair. The authenticated user can no longer use the key pair to decrypt incoming CSE message texts or sign outgoing CSE mail. To regain access, use the EnableCseKeyPair to turn on the key pair. After 30 days, you can permanently delete the key pair by using the ObliterateCseKeyPair method.</p>
<p class="toc_element">
<code><a href="#enable">enable(userId, keyPairId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Turns on a client-side encryption key pair that was turned off. The key pair becomes active again for any associated client-side encryption identities.</p>
<p class="toc_element">
<code><a href="#get">get(userId, keyPairId, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves an existing client-side encryption key pair.</p>
<p class="toc_element">
<code><a href="#list">list(userId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists client-side encryption key pairs for an authenticated user.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#obliterate">obliterate(userId, keyPairId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a client-side encryption key pair permanently and immediately. You can only permanently delete key pairs that have been turned off for more than 30 days. To turn off a key pair, use the DisableCseKeyPair method. Gmail can't restore or decrypt any messages that were encrypted by an obliterated key. Authenticated users and Google Workspace administrators lose access to reading the encrypted messages.</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="create">create(userId, body=None, x__xgafv=None)</code>
<pre>Creates and uploads a client-side encryption S/MIME public key certificate chain and private key metadata for the authenticated user.
Args:
userId: string, The requester's primary email address. To indicate the authenticated user, you can use the special value `me`. (required)
body: object, The request body.
The object takes the form of:
{ # A client-side encryption S/MIME key pair, which is comprised of a public key, its certificate chain, and metadata for its paired private key. Gmail uses the key pair to complete the following tasks: - Sign outgoing client-side encrypted messages. - Save and reopen drafts of client-side encrypted messages. - Save and reopen sent messages. - Decrypt incoming or archived S/MIME messages.
"disableTime": "A String", # Output only. If a key pair is set to `DISABLED`, the time that the key pair's state changed from `ENABLED` to `DISABLED`. This field is present only when the key pair is in state `DISABLED`.
"enablementState": "A String", # Output only. The current state of the key pair.
"keyPairId": "A String", # Output only. The immutable ID for the client-side encryption S/MIME key pair.
"pem": "A String", # Output only. The public key and its certificate chain, in [PEM](https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail) format.
"pkcs7": "A String", # Input only. The public key and its certificate chain. The chain must be in [PKCS#7](https://en.wikipedia.org/wiki/PKCS_7) format and use PEM encoding and ASCII armor.
"privateKeyMetadata": [ # Metadata for instances of this key pair's private key.
{ # Metadata for a private key instance.
"kaclsKeyMetadata": { # Metadata for private keys managed by an external key access control list service. For details about managing key access, see [Google Workspace CSE API Reference](https://developers.google.com/workspace/cse/reference). # Metadata for a private key instance managed by an external key access control list service.
"kaclsData": "A String", # Opaque data generated and used by the key access control list service. Maximum size: 8 KiB.
"kaclsUri": "A String", # The URI of the key access control list service that manages the private key.
},
"pivKeyMetadata": { # Metadata for a personal identity verification (PIV) private key that requires a card reader for access. # Metadata for PIV card certificate.
"description": "A String", # Description about the PIV key.
},
"privateKeyMetadataId": "A String", # Output only. The immutable ID for the private key metadata instance.
},
],
"subjectEmailAddresses": [ # Output only. The email address identities that are specified on the leaf certificate.
"A String",
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A client-side encryption S/MIME key pair, which is comprised of a public key, its certificate chain, and metadata for its paired private key. Gmail uses the key pair to complete the following tasks: - Sign outgoing client-side encrypted messages. - Save and reopen drafts of client-side encrypted messages. - Save and reopen sent messages. - Decrypt incoming or archived S/MIME messages.
"disableTime": "A String", # Output only. If a key pair is set to `DISABLED`, the time that the key pair's state changed from `ENABLED` to `DISABLED`. This field is present only when the key pair is in state `DISABLED`.
"enablementState": "A String", # Output only. The current state of the key pair.
"keyPairId": "A String", # Output only. The immutable ID for the client-side encryption S/MIME key pair.
"pem": "A String", # Output only. The public key and its certificate chain, in [PEM](https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail) format.
"pkcs7": "A String", # Input only. The public key and its certificate chain. The chain must be in [PKCS#7](https://en.wikipedia.org/wiki/PKCS_7) format and use PEM encoding and ASCII armor.
"privateKeyMetadata": [ # Metadata for instances of this key pair's private key.
{ # Metadata for a private key instance.
"kaclsKeyMetadata": { # Metadata for private keys managed by an external key access control list service. For details about managing key access, see [Google Workspace CSE API Reference](https://developers.google.com/workspace/cse/reference). # Metadata for a private key instance managed by an external key access control list service.
"kaclsData": "A String", # Opaque data generated and used by the key access control list service. Maximum size: 8 KiB.
"kaclsUri": "A String", # The URI of the key access control list service that manages the private key.
},
"pivKeyMetadata": { # Metadata for a personal identity verification (PIV) private key that requires a card reader for access. # Metadata for PIV card certificate.
"description": "A String", # Description about the PIV key.
},
"privateKeyMetadataId": "A String", # Output only. The immutable ID for the private key metadata instance.
},
],
"subjectEmailAddresses": [ # Output only. The email address identities that are specified on the leaf certificate.
"A String",
],
}</pre>
</div>
<div class="method">
<code class="details" id="disable">disable(userId, keyPairId, body=None, x__xgafv=None)</code>
<pre>Turns off a client-side encryption key pair. The authenticated user can no longer use the key pair to decrypt incoming CSE message texts or sign outgoing CSE mail. To regain access, use the EnableCseKeyPair to turn on the key pair. After 30 days, you can permanently delete the key pair by using the ObliterateCseKeyPair method.
Args:
userId: string, The requester's primary email address. To indicate the authenticated user, you can use the special value `me`. (required)
keyPairId: string, The identifier of the key pair to turn off. (required)
body: object, The request body.
The object takes the form of:
{ # Requests to turn off a client-side encryption key pair.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A client-side encryption S/MIME key pair, which is comprised of a public key, its certificate chain, and metadata for its paired private key. Gmail uses the key pair to complete the following tasks: - Sign outgoing client-side encrypted messages. - Save and reopen drafts of client-side encrypted messages. - Save and reopen sent messages. - Decrypt incoming or archived S/MIME messages.
"disableTime": "A String", # Output only. If a key pair is set to `DISABLED`, the time that the key pair's state changed from `ENABLED` to `DISABLED`. This field is present only when the key pair is in state `DISABLED`.
"enablementState": "A String", # Output only. The current state of the key pair.
"keyPairId": "A String", # Output only. The immutable ID for the client-side encryption S/MIME key pair.
"pem": "A String", # Output only. The public key and its certificate chain, in [PEM](https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail) format.
"pkcs7": "A String", # Input only. The public key and its certificate chain. The chain must be in [PKCS#7](https://en.wikipedia.org/wiki/PKCS_7) format and use PEM encoding and ASCII armor.
"privateKeyMetadata": [ # Metadata for instances of this key pair's private key.
{ # Metadata for a private key instance.
"kaclsKeyMetadata": { # Metadata for private keys managed by an external key access control list service. For details about managing key access, see [Google Workspace CSE API Reference](https://developers.google.com/workspace/cse/reference). # Metadata for a private key instance managed by an external key access control list service.
"kaclsData": "A String", # Opaque data generated and used by the key access control list service. Maximum size: 8 KiB.
"kaclsUri": "A String", # The URI of the key access control list service that manages the private key.
},
"pivKeyMetadata": { # Metadata for a personal identity verification (PIV) private key that requires a card reader for access. # Metadata for PIV card certificate.
"description": "A String", # Description about the PIV key.
},
"privateKeyMetadataId": "A String", # Output only. The immutable ID for the private key metadata instance.
},
],
"subjectEmailAddresses": [ # Output only. The email address identities that are specified on the leaf certificate.
"A String",
],
}</pre>
</div>
<div class="method">
<code class="details" id="enable">enable(userId, keyPairId, body=None, x__xgafv=None)</code>
<pre>Turns on a client-side encryption key pair that was turned off. The key pair becomes active again for any associated client-side encryption identities.
Args:
userId: string, The requester's primary email address. To indicate the authenticated user, you can use the special value `me`. (required)
keyPairId: string, The identifier of the key pair to turn on. (required)
body: object, The request body.
The object takes the form of:
{ # Requests to turn on a client-side encryption key pair.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A client-side encryption S/MIME key pair, which is comprised of a public key, its certificate chain, and metadata for its paired private key. Gmail uses the key pair to complete the following tasks: - Sign outgoing client-side encrypted messages. - Save and reopen drafts of client-side encrypted messages. - Save and reopen sent messages. - Decrypt incoming or archived S/MIME messages.
"disableTime": "A String", # Output only. If a key pair is set to `DISABLED`, the time that the key pair's state changed from `ENABLED` to `DISABLED`. This field is present only when the key pair is in state `DISABLED`.
"enablementState": "A String", # Output only. The current state of the key pair.
"keyPairId": "A String", # Output only. The immutable ID for the client-side encryption S/MIME key pair.
"pem": "A String", # Output only. The public key and its certificate chain, in [PEM](https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail) format.
"pkcs7": "A String", # Input only. The public key and its certificate chain. The chain must be in [PKCS#7](https://en.wikipedia.org/wiki/PKCS_7) format and use PEM encoding and ASCII armor.
"privateKeyMetadata": [ # Metadata for instances of this key pair's private key.
{ # Metadata for a private key instance.
"kaclsKeyMetadata": { # Metadata for private keys managed by an external key access control list service. For details about managing key access, see [Google Workspace CSE API Reference](https://developers.google.com/workspace/cse/reference). # Metadata for a private key instance managed by an external key access control list service.
"kaclsData": "A String", # Opaque data generated and used by the key access control list service. Maximum size: 8 KiB.
"kaclsUri": "A String", # The URI of the key access control list service that manages the private key.
},
"pivKeyMetadata": { # Metadata for a personal identity verification (PIV) private key that requires a card reader for access. # Metadata for PIV card certificate.
"description": "A String", # Description about the PIV key.
},
"privateKeyMetadataId": "A String", # Output only. The immutable ID for the private key metadata instance.
},
],
"subjectEmailAddresses": [ # Output only. The email address identities that are specified on the leaf certificate.
"A String",
],
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(userId, keyPairId, x__xgafv=None)</code>
<pre>Retrieves an existing client-side encryption key pair.
Args:
userId: string, The requester's primary email address. To indicate the authenticated user, you can use the special value `me`. (required)
keyPairId: string, The identifier of the key pair to retrieve. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A client-side encryption S/MIME key pair, which is comprised of a public key, its certificate chain, and metadata for its paired private key. Gmail uses the key pair to complete the following tasks: - Sign outgoing client-side encrypted messages. - Save and reopen drafts of client-side encrypted messages. - Save and reopen sent messages. - Decrypt incoming or archived S/MIME messages.
"disableTime": "A String", # Output only. If a key pair is set to `DISABLED`, the time that the key pair's state changed from `ENABLED` to `DISABLED`. This field is present only when the key pair is in state `DISABLED`.
"enablementState": "A String", # Output only. The current state of the key pair.
"keyPairId": "A String", # Output only. The immutable ID for the client-side encryption S/MIME key pair.
"pem": "A String", # Output only. The public key and its certificate chain, in [PEM](https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail) format.
"pkcs7": "A String", # Input only. The public key and its certificate chain. The chain must be in [PKCS#7](https://en.wikipedia.org/wiki/PKCS_7) format and use PEM encoding and ASCII armor.
"privateKeyMetadata": [ # Metadata for instances of this key pair's private key.
{ # Metadata for a private key instance.
"kaclsKeyMetadata": { # Metadata for private keys managed by an external key access control list service. For details about managing key access, see [Google Workspace CSE API Reference](https://developers.google.com/workspace/cse/reference). # Metadata for a private key instance managed by an external key access control list service.
"kaclsData": "A String", # Opaque data generated and used by the key access control list service. Maximum size: 8 KiB.
"kaclsUri": "A String", # The URI of the key access control list service that manages the private key.
},
"pivKeyMetadata": { # Metadata for a personal identity verification (PIV) private key that requires a card reader for access. # Metadata for PIV card certificate.
"description": "A String", # Description about the PIV key.
},
"privateKeyMetadataId": "A String", # Output only. The immutable ID for the private key metadata instance.
},
],
"subjectEmailAddresses": [ # Output only. The email address identities that are specified on the leaf certificate.
"A String",
],
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(userId, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists client-side encryption key pairs for an authenticated user.
Args:
userId: string, The requester's primary email address. To indicate the authenticated user, you can use the special value `me`. (required)
pageSize: integer, The number of key pairs to return. If not provided, the page size will default to 20 entries.
pageToken: string, Pagination token indicating which page of key pairs to return. If the token is not supplied, then the API will return the first page of results.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"cseKeyPairs": [ # One page of the list of CSE key pairs installed for the user.
{ # A client-side encryption S/MIME key pair, which is comprised of a public key, its certificate chain, and metadata for its paired private key. Gmail uses the key pair to complete the following tasks: - Sign outgoing client-side encrypted messages. - Save and reopen drafts of client-side encrypted messages. - Save and reopen sent messages. - Decrypt incoming or archived S/MIME messages.
"disableTime": "A String", # Output only. If a key pair is set to `DISABLED`, the time that the key pair's state changed from `ENABLED` to `DISABLED`. This field is present only when the key pair is in state `DISABLED`.
"enablementState": "A String", # Output only. The current state of the key pair.
"keyPairId": "A String", # Output only. The immutable ID for the client-side encryption S/MIME key pair.
"pem": "A String", # Output only. The public key and its certificate chain, in [PEM](https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail) format.
"pkcs7": "A String", # Input only. The public key and its certificate chain. The chain must be in [PKCS#7](https://en.wikipedia.org/wiki/PKCS_7) format and use PEM encoding and ASCII armor.
"privateKeyMetadata": [ # Metadata for instances of this key pair's private key.
{ # Metadata for a private key instance.
"kaclsKeyMetadata": { # Metadata for private keys managed by an external key access control list service. For details about managing key access, see [Google Workspace CSE API Reference](https://developers.google.com/workspace/cse/reference). # Metadata for a private key instance managed by an external key access control list service.
"kaclsData": "A String", # Opaque data generated and used by the key access control list service. Maximum size: 8 KiB.
"kaclsUri": "A String", # The URI of the key access control list service that manages the private key.
},
"pivKeyMetadata": { # Metadata for a personal identity verification (PIV) private key that requires a card reader for access. # Metadata for PIV card certificate.
"description": "A String", # Description about the PIV key.
},
"privateKeyMetadataId": "A String", # Output only. The immutable ID for the private key metadata instance.
},
],
"subjectEmailAddresses": [ # Output only. The email address identities that are specified on the leaf certificate.
"A String",
],
},
],
"nextPageToken": "A String", # Pagination token to be passed to a subsequent ListCseKeyPairs call in order to retrieve the next page of key pairs. If this value is not returned, then no further pages remain.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="obliterate">obliterate(userId, keyPairId, body=None, x__xgafv=None)</code>
<pre>Deletes a client-side encryption key pair permanently and immediately. You can only permanently delete key pairs that have been turned off for more than 30 days. To turn off a key pair, use the DisableCseKeyPair method. Gmail can't restore or decrypt any messages that were encrypted by an obliterated key. Authenticated users and Google Workspace administrators lose access to reading the encrypted messages.
Args:
userId: string, The requester's primary email address. To indicate the authenticated user, you can use the special value `me`. (required)
keyPairId: string, The identifier of the key pair to obliterate. (required)
body: object, The request body.
The object takes the form of:
{ # Request to obliterate a CSE key pair.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
</pre>
</div>
</body></html>