Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3bf2781e29cb828409f3a8a21939323286524569 / . / docs / dyn / licensing_v1.licenseAssignments.html
blob: c939d4afebbd5887a7044f527b1cecd09083f8b8 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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="licensing_v1.html">Enterprise License Manager API</a> . <a href="licensing_v1.licenseAssignments.html">licenseAssignments</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(productId, skuId, userId)</a></code></p>
79<p class="firstline">Revoke License.</p>
80<p class="toc_element">
81 <code><a href="#get">get(productId, skuId, userId)</a></code></p>
82<p class="firstline">Get license assignment of a particular product and sku for a user</p>
83<p class="toc_element">
84 <code><a href="#insert">insert(productId, skuId, body)</a></code></p>
85<p class="firstline">Assign License.</p>
86<p class="toc_element">
87 <code><a href="#listForProduct">listForProduct(productId, customerId, pageToken=None, maxResults=None)</a></code></p>
88<p class="firstline">List license assignments for given product of the customer.</p>
89<p class="toc_element">
90 <code><a href="#listForProductAndSku">listForProductAndSku(productId, skuId, customerId, pageToken=None, maxResults=None)</a></code></p>
91<p class="firstline">List license assignments for given product and sku of the customer.</p>
92<p class="toc_element">
93 <code><a href="#listForProductAndSku_next">listForProductAndSku_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<p class="toc_element">
96 <code><a href="#listForProduct_next">listForProduct_next(previous_request, previous_response)</a></code></p>
97<p class="firstline">Retrieves the next page of results.</p>
98<p class="toc_element">
99 <code><a href="#patch">patch(productId, skuId, userId, body)</a></code></p>
100<p class="firstline">Assign License. This method supports patch semantics.</p>
101<p class="toc_element">
102 <code><a href="#update">update(productId, skuId, userId, body)</a></code></p>
103<p class="firstline">Assign License.</p>
104<h3>Method Details</h3>
105<div class="method">
106 <code class="details" id="delete">delete(productId, skuId, userId)</code>
107 <pre>Revoke License.
108
109Args:
110 productId: string, Name for product (required)
111 skuId: string, Name for sku (required)
112 userId: string, email id or unique Id of the user (required)
113</pre>
114</div>
115
116<div class="method">
117 <code class="details" id="get">get(productId, skuId, userId)</code>
118 <pre>Get license assignment of a particular product and sku for a user
119
120Args:
121 productId: string, Name for product (required)
122 skuId: string, Name for sku (required)
123 userId: string, email id or unique Id of the user (required)
124
125Returns:
126 An object of the form:
127
128 { # Template for LiscenseAssignment Resource
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]129 "skuId": "A String", # Id of the sku of the product.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]130 "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
131 "userId": "A String", # Email id of the user.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]132 "productName": "A String", # Display Name of the product.
133 "skuName": "A String", # Display Name of the sku of the product.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]134 "etags": "A String", # ETag of the resource.
135 "selfLink": "A String", # Link to this page.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]136 "productId": "A String", # Id of the product.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]137 }</pre>
138</div>
139
140<div class="method">
141 <code class="details" id="insert">insert(productId, skuId, body)</code>
142 <pre>Assign License.
143
144Args:
145 productId: string, Name for product (required)
146 skuId: string, Name for sku (required)
147 body: object, The request body. (required)
148 The object takes the form of:
149
150{ # Template for LicenseAssignment Insert request
151 "userId": "A String", # Email id of the user
152 }
153
154
155Returns:
156 An object of the form:
157
158 { # Template for LiscenseAssignment Resource
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]159 "skuId": "A String", # Id of the sku of the product.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]160 "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
161 "userId": "A String", # Email id of the user.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]162 "productName": "A String", # Display Name of the product.
163 "skuName": "A String", # Display Name of the sku of the product.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]164 "etags": "A String", # ETag of the resource.
165 "selfLink": "A String", # Link to this page.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]166 "productId": "A String", # Id of the product.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]167 }</pre>
168</div>
169
170<div class="method">
171 <code class="details" id="listForProduct">listForProduct(productId, customerId, pageToken=None, maxResults=None)</code>
172 <pre>List license assignments for given product of the customer.
173
174Args:
175 productId: string, Name for product (required)
176 customerId: string, CustomerId represents the customer for whom licenseassignments are queried (required)
177 pageToken: string, Token to fetch the next page.Optional. By default server will return first page
178 maxResults: integer, Maximum number of campaigns to return at one time. Must be positive. Optional. Default value is 100.
179
180Returns:
181 An object of the form:
182
183 { # LicesnseAssignment List for a given product/sku for a customer.
184 "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
185 "items": [ # The LicenseAssignments in this page of results.
186 { # Template for LiscenseAssignment Resource
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]187 "skuId": "A String", # Id of the sku of the product.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]188 "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
189 "userId": "A String", # Email id of the user.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]190 "productName": "A String", # Display Name of the product.
191 "skuName": "A String", # Display Name of the sku of the product.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]192 "etags": "A String", # ETag of the resource.
193 "selfLink": "A String", # Link to this page.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]194 "productId": "A String", # Id of the product.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]195 },
196 ],
197 "kind": "licensing#licenseAssignmentList", # Identifies the resource as a collection of LicenseAssignments.
198 "etag": "A String", # ETag of the resource.
199 }</pre>
200</div>
201
202<div class="method">
203 <code class="details" id="listForProductAndSku">listForProductAndSku(productId, skuId, customerId, pageToken=None, maxResults=None)</code>
204 <pre>List license assignments for given product and sku of the customer.
205
206Args:
207 productId: string, Name for product (required)
208 skuId: string, Name for sku (required)
209 customerId: string, CustomerId represents the customer for whom licenseassignments are queried (required)
210 pageToken: string, Token to fetch the next page.Optional. By default server will return first page
211 maxResults: integer, Maximum number of campaigns to return at one time. Must be positive. Optional. Default value is 100.
212
213Returns:
214 An object of the form:
215
216 { # LicesnseAssignment List for a given product/sku for a customer.
217 "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
218 "items": [ # The LicenseAssignments in this page of results.
219 { # Template for LiscenseAssignment Resource
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]220 "skuId": "A String", # Id of the sku of the product.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]221 "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
222 "userId": "A String", # Email id of the user.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]223 "productName": "A String", # Display Name of the product.
224 "skuName": "A String", # Display Name of the sku of the product.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]225 "etags": "A String", # ETag of the resource.
226 "selfLink": "A String", # Link to this page.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]227 "productId": "A String", # Id of the product.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]228 },
229 ],
230 "kind": "licensing#licenseAssignmentList", # Identifies the resource as a collection of LicenseAssignments.
231 "etag": "A String", # ETag of the resource.
232 }</pre>
233</div>
234
235<div class="method">
236 <code class="details" id="listForProductAndSku_next">listForProductAndSku_next(previous_request, previous_response)</code>
237 <pre>Retrieves the next page of results.
238
239Args:
240 previous_request: The request for the previous page. (required)
241 previous_response: The response from the request for the previous page. (required)
242
243Returns:
244 A request object that you can call 'execute()' on to request the next
245 page. Returns None if there are no more items in the collection.
246 </pre>
247</div>
248
249<div class="method">
250 <code class="details" id="listForProduct_next">listForProduct_next(previous_request, previous_response)</code>
251 <pre>Retrieves the next page of results.
252
253Args:
254 previous_request: The request for the previous page. (required)
255 previous_response: The response from the request for the previous page. (required)
256
257Returns:
258 A request object that you can call 'execute()' on to request the next
259 page. Returns None if there are no more items in the collection.
260 </pre>
261</div>
262
263<div class="method">
264 <code class="details" id="patch">patch(productId, skuId, userId, body)</code>
265 <pre>Assign License. This method supports patch semantics.
266
267Args:
268 productId: string, Name for product (required)
269 skuId: string, Name for sku for which license would be revoked (required)
270 userId: string, email id or unique Id of the user (required)
271 body: object, The request body. (required)
272 The object takes the form of:
273
274{ # Template for LiscenseAssignment Resource
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]275 "skuId": "A String", # Id of the sku of the product.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]276 "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
277 "userId": "A String", # Email id of the user.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]278 "productName": "A String", # Display Name of the product.
279 "skuName": "A String", # Display Name of the sku of the product.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]280 "etags": "A String", # ETag of the resource.
281 "selfLink": "A String", # Link to this page.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]282 "productId": "A String", # Id of the product.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]283}
284
285
286Returns:
287 An object of the form:
288
289 { # Template for LiscenseAssignment Resource
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]290 "skuId": "A String", # Id of the sku of the product.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]291 "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
292 "userId": "A String", # Email id of the user.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]293 "productName": "A String", # Display Name of the product.
294 "skuName": "A String", # Display Name of the sku of the product.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]295 "etags": "A String", # ETag of the resource.
296 "selfLink": "A String", # Link to this page.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]297 "productId": "A String", # Id of the product.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]298 }</pre>
299</div>
300
301<div class="method">
302 <code class="details" id="update">update(productId, skuId, userId, body)</code>
303 <pre>Assign License.
304
305Args:
306 productId: string, Name for product (required)
307 skuId: string, Name for sku for which license would be revoked (required)
308 userId: string, email id or unique Id of the user (required)
309 body: object, The request body. (required)
310 The object takes the form of:
311
312{ # Template for LiscenseAssignment Resource
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]313 "skuId": "A String", # Id of the sku of the product.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]314 "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
315 "userId": "A String", # Email id of the user.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]316 "productName": "A String", # Display Name of the product.
317 "skuName": "A String", # Display Name of the sku of the product.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]318 "etags": "A String", # ETag of the resource.
319 "selfLink": "A String", # Link to this page.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]320 "productId": "A String", # Id of the product.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]321}
322
323
324Returns:
325 An object of the form:
326
327 { # Template for LiscenseAssignment Resource
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]328 "skuId": "A String", # Id of the sku of the product.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]329 "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
330 "userId": "A String", # Email id of the user.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]331 "productName": "A String", # Display Name of the product.
332 "skuName": "A String", # Display Name of the sku of the product.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]333 "etags": "A String", # ETag of the resource.
334 "selfLink": "A String", # Link to this page.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]335 "productId": "A String", # Id of the product.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]336 }</pre>
337</div>
338
339</body></html>