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
|
<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="chromemanagement_v1.html">Chrome Management API</a> . <a href="chromemanagement_v1.customers.html">customers</a> . <a href="chromemanagement_v1.customers.certificateProvisioningProcesses.html">certificateProvisioningProcesses</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="chromemanagement_v1.customers.certificateProvisioningProcesses.operations.html">operations()</a></code>
</p>
<p class="firstline">Returns the operations Resource.</p>
<p class="toc_element">
<code><a href="#claim">claim(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Claims a certificate provisioning process. For each certificate provisioning process, this operation can succeed only for one `caller_instance_id`.</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="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a certificate provisioning process.</p>
<p class="toc_element">
<code><a href="#setFailure">setFailure(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Marks a certificate provisioning process as failed.</p>
<p class="toc_element">
<code><a href="#signData">signData(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Requests the client that initiated a certificate provisioning process to sign data. This should only be called after `ClaimCertificateProvisioningProcess` has been successfully executed.</p>
<p class="toc_element">
<code><a href="#uploadCertificate">uploadCertificate(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Uploads a successfully issued certificate for a certificate provisioning process.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="claim">claim(name, body=None, x__xgafv=None)</code>
<pre>Claims a certificate provisioning process. For each certificate provisioning process, this operation can succeed only for one `caller_instance_id`.
Args:
name: string, Required. Resource name of the `CertificateProvisioningProcess` to claim. The name pattern is given as `customers/{customer}/certificateProvisioningProcesses/{certificate_provisioning_process}` with `{customer}` being the obfuscated customer id and `{certificate_provisioning_process}` being the certificate provisioning process id. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for claiming a certificate provisioning process.
"callerInstanceId": "A String", # Required. The instance id of the caller.
}
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 claiming a certificate provisioning process.
}</pre>
</div>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Retrieves a certificate provisioning process.
Args:
name: string, Required. Resource name of the `CertificateProvisioningProcess` to return. The name pattern is given as `customers/{customer}/certificateProvisioningProcesses/{certificate_provisioning_process}` with `{customer}` being the obfuscated customer id and `{certificate_provisioning_process}` being the certificate provisioning process id. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A certificate provisioning process.
"chromeOsDevice": { # Describes the ChromeOS device that a `CertificateProvisioningProcess` belongs to. # Output only. The client certificate is being provisioned for a ChromeOS device. This contains information about the device.
"deviceDirectoryApiId": "A String", # Output only. The unique Directory API ID of the device. This value is the same as the Admin Console's Directory API ID in the ChromeOS Devices tab.
"serialNumber": "A String", # Output only. Device serial number. This value is the same as the Admin Console's Serial Number in the ChromeOS Devices tab.
},
"chromeOsUserSession": { # Describes the ChromeOS user session that a `CertificateProvisioningProcess` belongs to. # Output only. The client certificate is being provisioned for a ChromeOS user. This contains information about the current user session.
"chromeOsDevice": { # Describes the ChromeOS device that a `CertificateProvisioningProcess` belongs to. # Output only. This field contains information about the ChromeOS device that the user session is running on. It is only set if the user is affiliated, i.e., if the user is managed by the same organization that manages the ChromeOS device.
"deviceDirectoryApiId": "A String", # Output only. The unique Directory API ID of the device. This value is the same as the Admin Console's Directory API ID in the ChromeOS Devices tab.
"serialNumber": "A String", # Output only. Device serial number. This value is the same as the Admin Console's Serial Number in the ChromeOS Devices tab.
},
"userDirectoryApiId": "A String", # Output only. The unique Directory API ID of the user.
"userPrimaryEmail": "A String", # Output only. The primary e-mail address of the user.
},
"failureMessage": "A String", # Output only. A message describing why this `CertificateProvisioningProcess` has failed. Presence of this field indicates that the `CertificateProvisioningProcess` has failed.
"genericCaConnection": { # Describes a generic Certificate Authority Connection. # Output only. The CA connection is a generic CA connection.
"caConnectionAdapterConfigReference": "A String", # Output only. A string that references the administrator-provided configuration for the certification authority service.
},
"genericProfile": { # Describes a generic certificate provisioning profile. # Output only. The profile is a generic certificate provisioning profile.
"profileAdapterConfigReference": "A String", # Output only. A string that references the administrator-provided configuration for the certificate provisioning profile.
},
"issuedCertificate": "A String", # Output only. The issued certificate for this `CertificateProvisioningProcess` in PEM format.
"name": "A String", # Identifier. Resource name of the `CertificateProvisioningProcess`. The name pattern is given as `customers/{customer}/certificateProvisioningProcesses/{certificate_provisioning_process}` with `{customer}` being the obfuscated customer id and `{certificate_provisioning_process}` being the certificate provisioning process id.
"provisioningProfileId": "A String", # Output only. The ID of the certificate provisioning profile.
"scepCaConnection": { # Describes a SCEP Certificate Authority Connection. # Output only. The CA connection is a SCEP CA connection.
"caConnectionAdapterConfigReference": "A String", # Output only. A string that references the administrator-provided configuration for the certification authority service.
},
"scepProfile": { # Describes a SCEP certificate provisioning profile. # Output only. The profile is a SCEP certificate provisioning profile.
"certificateTemplateName": "A String", # Output only. The certificate template name as defined by the admin on their on-prem infrastructure. The Certificate Authority uses this name to identify the certificate template.
"country": "A String", # Output only. The country of the subject.
"keyUsages": [ # Output only. The allowed key usages for certificate's key.
"A String",
],
"locality": "A String", # Output only. The locality of the subject.
"organization": "A String", # Output only. The name of the organization the subject belongs to.
"organizationalUnits": [ # Output only. The organizational units of the subject.
"A String",
],
"state": "A String", # Output only. The state of the subject.
"subjectAltNames": [ # Output only. The subject alternative names.
{ # Describes a subject alternative name.
"type": "A String", # Output only. The type of the SubjectAltName extension.
"value": "A String", # Output only. The value of the subject alternative name with respect to the `type`.
},
],
"subjectCommonName": "A String", # Output only. The common name of the subject.
},
"signData": "A String", # Output only. The data that the client was asked to sign. This field is only present after the `SignData` operation has been initiated.
"signature": "A String", # Output only. The signature of `signature_algorithm`, generated using the client's private key using `signature_algorithm`. This field is only present after the `SignData` operation has finished.
"signatureAlgorithm": "A String", # Output only. The signature algorithm that the client and backend components use when processing `sign_data`. If the `profile_type` is a `GenericProfile`, this field will only be present after the `SignData` operation was initiated. If the `profile_type` is a `ScepProfile`, the field will always be present.
"startTime": "A String", # Output only. Server-generated timestamp of when the certificate provisioning process has been created.
"subjectPublicKeyInfo": "A String", # Output only. The public key for which a certificate should be provisioned. Represented as a DER-encoded X.509 SubjectPublicKeyInfo.
}</pre>
</div>
<div class="method">
<code class="details" id="setFailure">setFailure(name, body=None, x__xgafv=None)</code>
<pre>Marks a certificate provisioning process as failed.
Args:
name: string, Required. Resource name of the `CertificateProvisioningProcess` to return. The name pattern is given as `customers/{customer}/certificateProvisioningProcesses/{certificate_provisioning_process}` with `{customer}` being the obfuscated customer id and `{certificate_provisioning_process}` being the certificate provisioning process id. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for marking a certificate provisioning process as failed.
"errorMessage": "A String", # Required. A message describing the failure details. It is displayed on the ChromeOS client device.
}
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 publishing a failure for a certificate provisioning process.
}</pre>
</div>
<div class="method">
<code class="details" id="signData">signData(name, body=None, x__xgafv=None)</code>
<pre>Requests the client that initiated a certificate provisioning process to sign data. This should only be called after `ClaimCertificateProvisioningProcess` has been successfully executed.
Args:
name: string, Required. Resource name of the `CertificateProvisioningProcess` to return. The name pattern is given as `customers/{customer}/certificateProvisioningProcesses/{certificate_provisioning_process}` with `{customer}` being the obfuscated customer id and `{certificate_provisioning_process}` being the certificate provisioning process id. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for requesting a signature from the client that initated a certificate provisioning process.
"signData": "A String", # Required. The data that the client was asked to sign.
"signatureAlgorithm": "A String", # Required. The signature algorithm that the adapter expects the client and backend components to use when processing `sign_data`.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="uploadCertificate">uploadCertificate(name, body=None, x__xgafv=None)</code>
<pre>Uploads a successfully issued certificate for a certificate provisioning process.
Args:
name: string, Required. Resource name of the `CertificateProvisioningProcess` to return. The name pattern is given as `customers/{customer}/certificateProvisioningProcesses/{certificate_provisioning_process}` with `{customer}` being the obfuscated customer id and `{certificate_provisioning_process}` being the certificate provisioning process id. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for uploading an issued certificate for a certificate provisioning process.
"certificatePem": "A String", # Required. The issued certificate 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 message for publishing an issued certificate for a certificate provisioning process.
}</pre>
</div>
</body></html>
|
