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
|
<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="apigee_v1.html">Apigee API</a> . <a href="apigee_v1.organizations.html">organizations</a> . <a href="apigee_v1.organizations.environments.html">environments</a> . <a href="apigee_v1.organizations.environments.keystores.html">keystores</a> . <a href="apigee_v1.organizations.environments.keystores.aliases.html">aliases</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(parent, alias=None, body=None, format=None, ignoreExpiryValidation=None, ignoreNewlineValidation=None, x__xgafv=None, x_password=None)</a></code></p>
<p class="firstline">Creates an alias from a key/certificate pair. The structure of the request is controlled by the `format` query parameter: - `keycertfile` - Separate PEM-encoded key and certificate files are uploaded. Set `Content-Type: multipart/form-data` and include the `keyFile`, `certFile`, and `password` (if keys are encrypted) fields in the request body. If uploading to a truststore, omit `keyFile`. - `pkcs12` - A PKCS12 file is uploaded. Set `Content-Type: multipart/form-data`, provide the file in the `file` field, and include the `password` field if the file is encrypted in the request body. - `selfsignedcert` - A new private key and certificate are generated. Set `Content-Type: application/json` and include CertificateGenerationSpec in the request body.</p>
<p class="toc_element">
<code><a href="#csr">csr(name, x__xgafv=None)</a></code></p>
<p class="firstline">Generates a PKCS #10 Certificate Signing Request for the private key in an alias.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes an alias.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets an alias.</p>
<p class="toc_element">
<code><a href="#getCertificate">getCertificate(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the certificate from an alias in PEM-encoded form.</p>
<p class="toc_element">
<code><a href="#update">update(name, body=None, ignoreExpiryValidation=None, ignoreNewlineValidation=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the certificate in an alias. The updated certificate must be in PEM- or DER-encoded X.509 format.</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(parent, alias=None, body=None, format=None, ignoreExpiryValidation=None, ignoreNewlineValidation=None, x__xgafv=None, x_password=None)</code>
<pre>Creates an alias from a key/certificate pair. The structure of the request is controlled by the `format` query parameter: - `keycertfile` - Separate PEM-encoded key and certificate files are uploaded. Set `Content-Type: multipart/form-data` and include the `keyFile`, `certFile`, and `password` (if keys are encrypted) fields in the request body. If uploading to a truststore, omit `keyFile`. - `pkcs12` - A PKCS12 file is uploaded. Set `Content-Type: multipart/form-data`, provide the file in the `file` field, and include the `password` field if the file is encrypted in the request body. - `selfsignedcert` - A new private key and certificate are generated. Set `Content-Type: application/json` and include CertificateGenerationSpec in the request body.
Args:
parent: string, Required. Name of the keystore. Use the following format in your request: `organizations/{org}/environments/{env}/keystores/{keystore}`. (required)
body: object, The request body.
The object takes the form of:
{ # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
"contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
"data": "A String", # The HTTP request/response body as raw binary.
"extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
}
alias: string, Alias for the key/certificate pair. Values must match the regular expression `[\w\s-.]{1,255}`. This must be provided for all formats except `selfsignedcert`; self-signed certs may specify the alias in either this parameter or the JSON body.
format: string, Required. Format of the data. Valid values include: `selfsignedcert`, `keycertfile`, or `pkcs12`
ignoreExpiryValidation: boolean, Flag that specifies whether to ignore expiry validation. If set to `true`, no expiry validation will be performed.
ignoreNewlineValidation: boolean, Flag that specifies whether to ignore newline validation. If set to `true`, no error is thrown when the file contains a certificate chain with no newline between each certificate. Defaults to `false`.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
x_password: string, DEPRECATED: For improved security, specify the password in the request body instead of using the query parameter. To specify the password in the request body, set `Content-type: multipart/form-data` part with name `password`. Password for the private key file, if required.
Returns:
An object of the form:
{ # Reference to a certificate or key/certificate pair.
"alias": "A String", # Resource ID for this alias. Values must match the regular expression `[^/]{1,255}`.
"certsInfo": { # Chain of certificates under this alias.
"certInfo": [ # Chain of certificates under this name.
{ # X.509 certificate as defined in RFC 5280.
"basicConstraints": "A String", # X.509 basic constraints extension.
"expiryDate": "A String", # X.509 `notAfter` validity period in milliseconds since epoch.
"isValid": "A String", # Flag that specifies whether the certificate is valid. Flag is set to `Yes` if the certificate is valid, `No` if expired, or `Not yet` if not yet valid.
"issuer": "A String", # X.509 issuer.
"publicKey": "A String", # Public key component of the X.509 subject public key info.
"serialNumber": "A String", # X.509 serial number.
"sigAlgName": "A String", # X.509 signatureAlgorithm.
"subject": "A String", # X.509 subject.
"subjectAlternativeNames": [ # X.509 subject alternative names (SANs) extension.
"A String",
],
"validFrom": "A String", # X.509 `notBefore` validity period in milliseconds since epoch.
"version": 42, # X.509 version.
},
],
},
"type": "A String", # Type of alias.
}</pre>
</div>
<div class="method">
<code class="details" id="csr">csr(name, x__xgafv=None)</code>
<pre>Generates a PKCS #10 Certificate Signing Request for the private key in an alias.
Args:
name: string, Required. Name of the alias. Use the following format in your request: `organizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
"contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
"data": "A String", # The HTTP request/response body as raw binary.
"extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes an alias.
Args:
name: string, Required. Name of the alias. Use the following format in your request: `organizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Reference to a certificate or key/certificate pair.
"alias": "A String", # Resource ID for this alias. Values must match the regular expression `[^/]{1,255}`.
"certsInfo": { # Chain of certificates under this alias.
"certInfo": [ # Chain of certificates under this name.
{ # X.509 certificate as defined in RFC 5280.
"basicConstraints": "A String", # X.509 basic constraints extension.
"expiryDate": "A String", # X.509 `notAfter` validity period in milliseconds since epoch.
"isValid": "A String", # Flag that specifies whether the certificate is valid. Flag is set to `Yes` if the certificate is valid, `No` if expired, or `Not yet` if not yet valid.
"issuer": "A String", # X.509 issuer.
"publicKey": "A String", # Public key component of the X.509 subject public key info.
"serialNumber": "A String", # X.509 serial number.
"sigAlgName": "A String", # X.509 signatureAlgorithm.
"subject": "A String", # X.509 subject.
"subjectAlternativeNames": [ # X.509 subject alternative names (SANs) extension.
"A String",
],
"validFrom": "A String", # X.509 `notBefore` validity period in milliseconds since epoch.
"version": 42, # X.509 version.
},
],
},
"type": "A String", # Type of alias.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets an alias.
Args:
name: string, Required. Name of the alias. Use the following format in your request: `organizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Reference to a certificate or key/certificate pair.
"alias": "A String", # Resource ID for this alias. Values must match the regular expression `[^/]{1,255}`.
"certsInfo": { # Chain of certificates under this alias.
"certInfo": [ # Chain of certificates under this name.
{ # X.509 certificate as defined in RFC 5280.
"basicConstraints": "A String", # X.509 basic constraints extension.
"expiryDate": "A String", # X.509 `notAfter` validity period in milliseconds since epoch.
"isValid": "A String", # Flag that specifies whether the certificate is valid. Flag is set to `Yes` if the certificate is valid, `No` if expired, or `Not yet` if not yet valid.
"issuer": "A String", # X.509 issuer.
"publicKey": "A String", # Public key component of the X.509 subject public key info.
"serialNumber": "A String", # X.509 serial number.
"sigAlgName": "A String", # X.509 signatureAlgorithm.
"subject": "A String", # X.509 subject.
"subjectAlternativeNames": [ # X.509 subject alternative names (SANs) extension.
"A String",
],
"validFrom": "A String", # X.509 `notBefore` validity period in milliseconds since epoch.
"version": 42, # X.509 version.
},
],
},
"type": "A String", # Type of alias.
}</pre>
</div>
<div class="method">
<code class="details" id="getCertificate">getCertificate(name, x__xgafv=None)</code>
<pre>Gets the certificate from an alias in PEM-encoded form.
Args:
name: string, Required. Name of the alias. Use the following format in your request: `organizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
"contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
"data": "A String", # The HTTP request/response body as raw binary.
"extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(name, body=None, ignoreExpiryValidation=None, ignoreNewlineValidation=None, x__xgafv=None)</code>
<pre>Updates the certificate in an alias. The updated certificate must be in PEM- or DER-encoded X.509 format.
Args:
name: string, Required. Name of the alias. Use the following format in your request: `organizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}` (required)
body: object, The request body.
The object takes the form of:
{ # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
"contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
"data": "A String", # The HTTP request/response body as raw binary.
"extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
}
ignoreExpiryValidation: boolean, Required. Flag that specifies whether to ignore expiry validation. If set to `true`, no expiry validation will be performed.
ignoreNewlineValidation: boolean, Flag that specifies whether to ignore newline validation. If set to `true`, no error is thrown when the file contains a certificate chain with no newline between each certificate. Defaults to `false`.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Reference to a certificate or key/certificate pair.
"alias": "A String", # Resource ID for this alias. Values must match the regular expression `[^/]{1,255}`.
"certsInfo": { # Chain of certificates under this alias.
"certInfo": [ # Chain of certificates under this name.
{ # X.509 certificate as defined in RFC 5280.
"basicConstraints": "A String", # X.509 basic constraints extension.
"expiryDate": "A String", # X.509 `notAfter` validity period in milliseconds since epoch.
"isValid": "A String", # Flag that specifies whether the certificate is valid. Flag is set to `Yes` if the certificate is valid, `No` if expired, or `Not yet` if not yet valid.
"issuer": "A String", # X.509 issuer.
"publicKey": "A String", # Public key component of the X.509 subject public key info.
"serialNumber": "A String", # X.509 serial number.
"sigAlgName": "A String", # X.509 signatureAlgorithm.
"subject": "A String", # X.509 subject.
"subjectAlternativeNames": [ # X.509 subject alternative names (SANs) extension.
"A String",
],
"validFrom": "A String", # X.509 `notBefore` validity period in milliseconds since epoch.
"version": 42, # X.509 version.
},
],
},
"type": "A String", # Type of alias.
}</pre>
</div>
</body></html>
|
