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
380
|
<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="licensing_v1.html">Enterprise License Manager API</a> . <a href="licensing_v1.licenseAssignments.html">licenseAssignments</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="#delete">delete(productId, skuId, userId, x__xgafv=None)</a></code></p>
<p class="firstline">Revoke a license.</p>
<p class="toc_element">
<code><a href="#get">get(productId, skuId, userId, x__xgafv=None)</a></code></p>
<p class="firstline">Get a specific user's license by product SKU.</p>
<p class="toc_element">
<code><a href="#insert">insert(productId, skuId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Assign a license.</p>
<p class="toc_element">
<code><a href="#listForProduct">listForProduct(productId, customerId, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">List all users assigned licenses for a specific product SKU.</p>
<p class="toc_element">
<code><a href="#listForProductAndSku">listForProductAndSku(productId, skuId, customerId, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">List all users assigned licenses for a specific product SKU.</p>
<p class="toc_element">
<code><a href="#listForProductAndSku_next">listForProductAndSku_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#listForProduct_next">listForProduct_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(productId, skuId, userId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Reassign a user's product SKU with a different SKU in the same product. This method supports patch semantics.</p>
<p class="toc_element">
<code><a href="#update">update(productId, skuId, userId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Reassign a user's product SKU with a different SKU in the same product.</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="delete">delete(productId, skuId, userId, x__xgafv=None)</code>
<pre>Revoke a license.
Args:
productId: string, A product's unique identifier. For more information about products in this version of the API, see Products and SKUs. (required)
skuId: string, A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs. (required)
userId: string, The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a `userId` is subject to change, do not use a `userId` value as a key for persistent data. This key could break if the current user's email address changes. If the `userId` is suspended, the license status changes. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(productId, skuId, userId, x__xgafv=None)</code>
<pre>Get a specific user's license by product SKU.
Args:
productId: string, A product's unique identifier. For more information about products in this version of the API, see Products and SKUs. (required)
skuId: string, A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs. (required)
userId: string, The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a `userId` is subject to change, do not use a `userId` value as a key for persistent data. This key could break if the current user's email address changes. If the `userId` is suspended, the license status changes. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Representation of a license assignment.
"etags": "A String", # ETag of the resource.
"kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment, which is `licensing#licenseAssignment`.
"productId": "A String", # A product's unique identifier. For more information about products in this version of the API, see Product and SKU IDs.
"productName": "A String", # Display Name of the product.
"selfLink": "A String", # Link to this page.
"skuId": "A String", # A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.
"skuName": "A String", # Display Name of the sku of the product.
"userId": "A String", # The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a `userId` is subject to change, do not use a `userId` value as a key for persistent data. This key could break if the current user's email address changes. If the `userId` is suspended, the license status changes.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(productId, skuId, body=None, x__xgafv=None)</code>
<pre>Assign a license.
Args:
productId: string, A product's unique identifier. For more information about products in this version of the API, see Products and SKUs. (required)
skuId: string, A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs. (required)
body: object, The request body.
The object takes the form of:
{ # Representation of a license assignment.
"userId": "A String", # Email id of the user
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Representation of a license assignment.
"etags": "A String", # ETag of the resource.
"kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment, which is `licensing#licenseAssignment`.
"productId": "A String", # A product's unique identifier. For more information about products in this version of the API, see Product and SKU IDs.
"productName": "A String", # Display Name of the product.
"selfLink": "A String", # Link to this page.
"skuId": "A String", # A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.
"skuName": "A String", # Display Name of the sku of the product.
"userId": "A String", # The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a `userId` is subject to change, do not use a `userId` value as a key for persistent data. This key could break if the current user's email address changes. If the `userId` is suspended, the license status changes.
}</pre>
</div>
<div class="method">
<code class="details" id="listForProduct">listForProduct(productId, customerId, maxResults=None, pageToken=None, x__xgafv=None)</code>
<pre>List all users assigned licenses for a specific product SKU.
Args:
productId: string, A product's unique identifier. For more information about products in this version of the API, see Products and SKUs. (required)
customerId: string, The customer's unique ID as defined in the Admin console, such as `C00000000`. If the customer is suspended, the server returns an error. (required)
maxResults: integer, The `maxResults` query string determines how many entries are returned on each page of a large response. This is an optional parameter. The value must be a positive number.
pageToken: string, Token to fetch the next page of data. The `maxResults` query string is related to the `pageToken` since `maxResults` determines how many entries are returned on each page. This is an optional query string. If not specified, the server returns the first page.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"etag": "A String", # ETag of the resource.
"items": [ # The LicenseAssignments in this page of results.
{ # Representation of a license assignment.
"etags": "A String", # ETag of the resource.
"kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment, which is `licensing#licenseAssignment`.
"productId": "A String", # A product's unique identifier. For more information about products in this version of the API, see Product and SKU IDs.
"productName": "A String", # Display Name of the product.
"selfLink": "A String", # Link to this page.
"skuId": "A String", # A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.
"skuName": "A String", # Display Name of the sku of the product.
"userId": "A String", # The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a `userId` is subject to change, do not use a `userId` value as a key for persistent data. This key could break if the current user's email address changes. If the `userId` is suspended, the license status changes.
},
],
"kind": "licensing#licenseAssignmentList", # Identifies the resource as a collection of LicenseAssignments.
"nextPageToken": "A String", # The token that you must submit in a subsequent request to retrieve additional license results matching your query parameters. The `maxResults` query string is related to the `nextPageToken` since `maxResults` determines how many entries are returned on each next page.
}</pre>
</div>
<div class="method">
<code class="details" id="listForProductAndSku">listForProductAndSku(productId, skuId, customerId, maxResults=None, pageToken=None, x__xgafv=None)</code>
<pre>List all users assigned licenses for a specific product SKU.
Args:
productId: string, A product's unique identifier. For more information about products in this version of the API, see Products and SKUs. (required)
skuId: string, A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs. (required)
customerId: string, The customer's unique ID as defined in the Admin console, such as `C00000000`. If the customer is suspended, the server returns an error. (required)
maxResults: integer, The `maxResults` query string determines how many entries are returned on each page of a large response. This is an optional parameter. The value must be a positive number.
pageToken: string, Token to fetch the next page of data. The `maxResults` query string is related to the `pageToken` since `maxResults` determines how many entries are returned on each page. This is an optional query string. If not specified, the server returns the first page.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"etag": "A String", # ETag of the resource.
"items": [ # The LicenseAssignments in this page of results.
{ # Representation of a license assignment.
"etags": "A String", # ETag of the resource.
"kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment, which is `licensing#licenseAssignment`.
"productId": "A String", # A product's unique identifier. For more information about products in this version of the API, see Product and SKU IDs.
"productName": "A String", # Display Name of the product.
"selfLink": "A String", # Link to this page.
"skuId": "A String", # A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.
"skuName": "A String", # Display Name of the sku of the product.
"userId": "A String", # The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a `userId` is subject to change, do not use a `userId` value as a key for persistent data. This key could break if the current user's email address changes. If the `userId` is suspended, the license status changes.
},
],
"kind": "licensing#licenseAssignmentList", # Identifies the resource as a collection of LicenseAssignments.
"nextPageToken": "A String", # The token that you must submit in a subsequent request to retrieve additional license results matching your query parameters. The `maxResults` query string is related to the `nextPageToken` since `maxResults` determines how many entries are returned on each next page.
}</pre>
</div>
<div class="method">
<code class="details" id="listForProductAndSku_next">listForProductAndSku_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="listForProduct_next">listForProduct_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="patch">patch(productId, skuId, userId, body=None, x__xgafv=None)</code>
<pre>Reassign a user's product SKU with a different SKU in the same product. This method supports patch semantics.
Args:
productId: string, A product's unique identifier. For more information about products in this version of the API, see Products and SKUs. (required)
skuId: string, A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs. (required)
userId: string, The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a `userId` is subject to change, do not use a `userId` value as a key for persistent data. This key could break if the current user's email address changes. If the `userId` is suspended, the license status changes. (required)
body: object, The request body.
The object takes the form of:
{ # Representation of a license assignment.
"etags": "A String", # ETag of the resource.
"kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment, which is `licensing#licenseAssignment`.
"productId": "A String", # A product's unique identifier. For more information about products in this version of the API, see Product and SKU IDs.
"productName": "A String", # Display Name of the product.
"selfLink": "A String", # Link to this page.
"skuId": "A String", # A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.
"skuName": "A String", # Display Name of the sku of the product.
"userId": "A String", # The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a `userId` is subject to change, do not use a `userId` value as a key for persistent data. This key could break if the current user's email address changes. If the `userId` is suspended, the license status changes.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Representation of a license assignment.
"etags": "A String", # ETag of the resource.
"kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment, which is `licensing#licenseAssignment`.
"productId": "A String", # A product's unique identifier. For more information about products in this version of the API, see Product and SKU IDs.
"productName": "A String", # Display Name of the product.
"selfLink": "A String", # Link to this page.
"skuId": "A String", # A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.
"skuName": "A String", # Display Name of the sku of the product.
"userId": "A String", # The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a `userId` is subject to change, do not use a `userId` value as a key for persistent data. This key could break if the current user's email address changes. If the `userId` is suspended, the license status changes.
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(productId, skuId, userId, body=None, x__xgafv=None)</code>
<pre>Reassign a user's product SKU with a different SKU in the same product.
Args:
productId: string, A product's unique identifier. For more information about products in this version of the API, see Products and SKUs. (required)
skuId: string, A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs. (required)
userId: string, The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a `userId` is subject to change, do not use a `userId` value as a key for persistent data. This key could break if the current user's email address changes. If the `userId` is suspended, the license status changes. (required)
body: object, The request body.
The object takes the form of:
{ # Representation of a license assignment.
"etags": "A String", # ETag of the resource.
"kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment, which is `licensing#licenseAssignment`.
"productId": "A String", # A product's unique identifier. For more information about products in this version of the API, see Product and SKU IDs.
"productName": "A String", # Display Name of the product.
"selfLink": "A String", # Link to this page.
"skuId": "A String", # A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.
"skuName": "A String", # Display Name of the sku of the product.
"userId": "A String", # The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a `userId` is subject to change, do not use a `userId` value as a key for persistent data. This key could break if the current user's email address changes. If the `userId` is suspended, the license status changes.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Representation of a license assignment.
"etags": "A String", # ETag of the resource.
"kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment, which is `licensing#licenseAssignment`.
"productId": "A String", # A product's unique identifier. For more information about products in this version of the API, see Product and SKU IDs.
"productName": "A String", # Display Name of the product.
"selfLink": "A String", # Link to this page.
"skuId": "A String", # A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.
"skuName": "A String", # Display Name of the sku of the product.
"userId": "A String", # The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a `userId` is subject to change, do not use a `userId` value as a key for persistent data. This key could break if the current user's email address changes. If the `userId` is suspended, the license status changes.
}</pre>
</div>
</body></html>
|
