Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 614db98bf45b9da1f29c35a9d942536111e99d41 / . / docs / dyn / licensing_v1.licenseAssignments.html
blob: c0df2a5a06fccbce9044e84b04496e8e8ac11fdc [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
129 "skuId": "A String", # Name of the sku of the product.
130 "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
131 "userId": "A String", # Email id of the user.
132 "etags": "A String", # ETag of the resource.
133 "selfLink": "A String", # Link to this page.
134 "productId": "A String", # Name of the product.
135 }</pre>
136</div>
137
138<div class="method">
139 <code class="details" id="insert">insert(productId, skuId, body)</code>
140 <pre>Assign License.
141
142Args:
143 productId: string, Name for product (required)
144 skuId: string, Name for sku (required)
145 body: object, The request body. (required)
146 The object takes the form of:
147
148{ # Template for LicenseAssignment Insert request
149 "userId": "A String", # Email id of the user
150 }
151
152
153Returns:
154 An object of the form:
155
156 { # Template for LiscenseAssignment Resource
157 "skuId": "A String", # Name of the sku of the product.
158 "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
159 "userId": "A String", # Email id of the user.
160 "etags": "A String", # ETag of the resource.
161 "selfLink": "A String", # Link to this page.
162 "productId": "A String", # Name of the product.
163 }</pre>
164</div>
165
166<div class="method">
167 <code class="details" id="listForProduct">listForProduct(productId, customerId, pageToken=None, maxResults=None)</code>
168 <pre>List license assignments for given product of the customer.
169
170Args:
171 productId: string, Name for product (required)
172 customerId: string, CustomerId represents the customer for whom licenseassignments are queried (required)
173 pageToken: string, Token to fetch the next page.Optional. By default server will return first page
174 maxResults: integer, Maximum number of campaigns to return at one time. Must be positive. Optional. Default value is 100.
175
176Returns:
177 An object of the form:
178
179 { # LicesnseAssignment List for a given product/sku for a customer.
180 "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.
181 "items": [ # The LicenseAssignments in this page of results.
182 { # Template for LiscenseAssignment Resource
183 "skuId": "A String", # Name of the sku of the product.
184 "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
185 "userId": "A String", # Email id of the user.
186 "etags": "A String", # ETag of the resource.
187 "selfLink": "A String", # Link to this page.
188 "productId": "A String", # Name of the product.
189 },
190 ],
191 "kind": "licensing#licenseAssignmentList", # Identifies the resource as a collection of LicenseAssignments.
192 "etag": "A String", # ETag of the resource.
193 }</pre>
194</div>
195
196<div class="method">
197 <code class="details" id="listForProductAndSku">listForProductAndSku(productId, skuId, customerId, pageToken=None, maxResults=None)</code>
198 <pre>List license assignments for given product and sku of the customer.
199
200Args:
201 productId: string, Name for product (required)
202 skuId: string, Name for sku (required)
203 customerId: string, CustomerId represents the customer for whom licenseassignments are queried (required)
204 pageToken: string, Token to fetch the next page.Optional. By default server will return first page
205 maxResults: integer, Maximum number of campaigns to return at one time. Must be positive. Optional. Default value is 100.
206
207Returns:
208 An object of the form:
209
210 { # LicesnseAssignment List for a given product/sku for a customer.
211 "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.
212 "items": [ # The LicenseAssignments in this page of results.
213 { # Template for LiscenseAssignment Resource
214 "skuId": "A String", # Name of the sku of the product.
215 "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
216 "userId": "A String", # Email id of the user.
217 "etags": "A String", # ETag of the resource.
218 "selfLink": "A String", # Link to this page.
219 "productId": "A String", # Name of the product.
220 },
221 ],
222 "kind": "licensing#licenseAssignmentList", # Identifies the resource as a collection of LicenseAssignments.
223 "etag": "A String", # ETag of the resource.
224 }</pre>
225</div>
226
227<div class="method">
228 <code class="details" id="listForProductAndSku_next">listForProductAndSku_next(previous_request, previous_response)</code>
229 <pre>Retrieves the next page of results.
230
231Args:
232 previous_request: The request for the previous page. (required)
233 previous_response: The response from the request for the previous page. (required)
234
235Returns:
236 A request object that you can call 'execute()' on to request the next
237 page. Returns None if there are no more items in the collection.
238 </pre>
239</div>
240
241<div class="method">
242 <code class="details" id="listForProduct_next">listForProduct_next(previous_request, previous_response)</code>
243 <pre>Retrieves the next page of results.
244
245Args:
246 previous_request: The request for the previous page. (required)
247 previous_response: The response from the request for the previous page. (required)
248
249Returns:
250 A request object that you can call 'execute()' on to request the next
251 page. Returns None if there are no more items in the collection.
252 </pre>
253</div>
254
255<div class="method">
256 <code class="details" id="patch">patch(productId, skuId, userId, body)</code>
257 <pre>Assign License. This method supports patch semantics.
258
259Args:
260 productId: string, Name for product (required)
261 skuId: string, Name for sku for which license would be revoked (required)
262 userId: string, email id or unique Id of the user (required)
263 body: object, The request body. (required)
264 The object takes the form of:
265
266{ # Template for LiscenseAssignment Resource
267 "skuId": "A String", # Name of the sku of the product.
268 "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
269 "userId": "A String", # Email id of the user.
270 "etags": "A String", # ETag of the resource.
271 "selfLink": "A String", # Link to this page.
272 "productId": "A String", # Name of the product.
273}
274
275
276Returns:
277 An object of the form:
278
279 { # Template for LiscenseAssignment Resource
280 "skuId": "A String", # Name of the sku of the product.
281 "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
282 "userId": "A String", # Email id of the user.
283 "etags": "A String", # ETag of the resource.
284 "selfLink": "A String", # Link to this page.
285 "productId": "A String", # Name of the product.
286 }</pre>
287</div>
288
289<div class="method">
290 <code class="details" id="update">update(productId, skuId, userId, body)</code>
291 <pre>Assign License.
292
293Args:
294 productId: string, Name for product (required)
295 skuId: string, Name for sku for which license would be revoked (required)
296 userId: string, email id or unique Id of the user (required)
297 body: object, The request body. (required)
298 The object takes the form of:
299
300{ # Template for LiscenseAssignment Resource
301 "skuId": "A String", # Name of the sku of the product.
302 "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
303 "userId": "A String", # Email id of the user.
304 "etags": "A String", # ETag of the resource.
305 "selfLink": "A String", # Link to this page.
306 "productId": "A String", # Name of the product.
307}
308
309
310Returns:
311 An object of the form:
312
313 { # Template for LiscenseAssignment Resource
314 "skuId": "A String", # Name of the sku of the product.
315 "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
316 "userId": "A String", # Email id of the user.
317 "etags": "A String", # ETag of the resource.
318 "selfLink": "A String", # Link to this page.
319 "productId": "A String", # Name of the product.
320 }</pre>
321</div>
322
323</body></html>