blob: 6f6c406c1eb6d892ac4901a9238ed87684efc91a [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -04001<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
Dan O'Mearadd494642020-05-01 07:42:23 -070075<h1><a href="licensing_v1.html">Licensing API</a> . <a href="licensing_v1.licenseAssignments.html">licenseAssignments</a></h1>
John Asmuth614db982014-04-24 15:46:26 -040076<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(productId, skuId, userId)</a></code></p>
Dan O'Mearadd494642020-05-01 07:42:23 -070079<p class="firstline">Revoke a license.</p>
John Asmuth614db982014-04-24 15:46:26 -040080<p class="toc_element">
81 <code><a href="#get">get(productId, skuId, userId)</a></code></p>
Dan O'Mearadd494642020-05-01 07:42:23 -070082<p class="firstline">Get a specific user's license by product SKU.</p>
John Asmuth614db982014-04-24 15:46:26 -040083<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070084 <code><a href="#insert">insert(productId, skuId, body=None)</a></code></p>
85<p class="firstline">Assign a license.</p>
John Asmuth614db982014-04-24 15:46:26 -040086<p class="toc_element">
87 <code><a href="#listForProduct">listForProduct(productId, customerId, pageToken=None, maxResults=None)</a></code></p>
Dan O'Mearadd494642020-05-01 07:42:23 -070088<p class="firstline">List all users assigned licenses for a specific product SKU.</p>
John Asmuth614db982014-04-24 15:46:26 -040089<p class="toc_element">
90 <code><a href="#listForProductAndSku">listForProductAndSku(productId, skuId, customerId, pageToken=None, maxResults=None)</a></code></p>
Dan O'Mearadd494642020-05-01 07:42:23 -070091<p class="firstline">List all users assigned licenses for a specific product SKU.</p>
John Asmuth614db982014-04-24 15:46:26 -040092<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">
Dan O'Mearadd494642020-05-01 07:42:23 -070099 <code><a href="#patch">patch(productId, skuId, userId, body=None)</a></code></p>
100<p class="firstline">Reassign a user's product SKU with a different SKU in the same product. This method supports patch semantics.</p>
John Asmuth614db982014-04-24 15:46:26 -0400101<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700102 <code><a href="#update">update(productId, skuId, userId, body=None)</a></code></p>
103<p class="firstline">Reassign a user's product SKU with a different SKU in the same product.</p>
John Asmuth614db982014-04-24 15:46:26 -0400104<h3>Method Details</h3>
105<div class="method">
106 <code class="details" id="delete">delete(productId, skuId, userId)</code>
Dan O'Mearadd494642020-05-01 07:42:23 -0700107 <pre>Revoke a license.
John Asmuth614db982014-04-24 15:46:26 -0400108
109Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700110 productId: string, A product's unique identifier. For more information about products in this version of the API, see Products and SKUs. (required)
111 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)
112 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.
113Since 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.
114If the userId is suspended, the license status changes. (required)
John Asmuth614db982014-04-24 15:46:26 -0400115</pre>
116</div>
117
118<div class="method">
119 <code class="details" id="get">get(productId, skuId, userId)</code>
Dan O'Mearadd494642020-05-01 07:42:23 -0700120 <pre>Get a specific user's license by product SKU.
John Asmuth614db982014-04-24 15:46:26 -0400121
122Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700123 productId: string, A product's unique identifier. For more information about products in this version of the API, see Products and SKUs. (required)
124 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)
125 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.
126Since 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.
127If the userId is suspended, the license status changes. (required)
John Asmuth614db982014-04-24 15:46:26 -0400128
129Returns:
130 An object of the form:
131
Dan O'Mearadd494642020-05-01 07:42:23 -0700132 { # Representation of a license assignment.
133 "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.
John Asmuth614db982014-04-24 15:46:26 -0400134 "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
Dan O'Mearadd494642020-05-01 07:42:23 -0700135 "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.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700136 "productName": "A String", # Display Name of the product.
137 "skuName": "A String", # Display Name of the sku of the product.
John Asmuth614db982014-04-24 15:46:26 -0400138 "etags": "A String", # ETag of the resource.
139 "selfLink": "A String", # Link to this page.
Dan O'Mearadd494642020-05-01 07:42:23 -0700140 "productId": "A String", # A product's unique identifier. For more information about products in this version of the API, see Product and SKU IDs.
John Asmuth614db982014-04-24 15:46:26 -0400141 }</pre>
142</div>
143
144<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700145 <code class="details" id="insert">insert(productId, skuId, body=None)</code>
146 <pre>Assign a license.
John Asmuth614db982014-04-24 15:46:26 -0400147
148Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700149 productId: string, A product's unique identifier. For more information about products in this version of the API, see Products and SKUs. (required)
150 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)
151 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400152 The object takes the form of:
153
Dan O'Mearadd494642020-05-01 07:42:23 -0700154{ # Representation of a license assignment.
John Asmuth614db982014-04-24 15:46:26 -0400155 "userId": "A String", # Email id of the user
156 }
157
158
159Returns:
160 An object of the form:
161
Dan O'Mearadd494642020-05-01 07:42:23 -0700162 { # Representation of a license assignment.
163 "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.
John Asmuth614db982014-04-24 15:46:26 -0400164 "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
Dan O'Mearadd494642020-05-01 07:42:23 -0700165 "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.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700166 "productName": "A String", # Display Name of the product.
167 "skuName": "A String", # Display Name of the sku of the product.
John Asmuth614db982014-04-24 15:46:26 -0400168 "etags": "A String", # ETag of the resource.
169 "selfLink": "A String", # Link to this page.
Dan O'Mearadd494642020-05-01 07:42:23 -0700170 "productId": "A String", # A product's unique identifier. For more information about products in this version of the API, see Product and SKU IDs.
John Asmuth614db982014-04-24 15:46:26 -0400171 }</pre>
172</div>
173
174<div class="method">
175 <code class="details" id="listForProduct">listForProduct(productId, customerId, pageToken=None, maxResults=None)</code>
Dan O'Mearadd494642020-05-01 07:42:23 -0700176 <pre>List all users assigned licenses for a specific product SKU.
John Asmuth614db982014-04-24 15:46:26 -0400177
178Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700179 productId: string, A product's unique identifier. For more information about products in this version of the API, see Products and SKUs. (required)
180 customerId: string, Customer's customerId. A previous version of this API accepted the primary domain name as a value for this field.
181If the customer is suspended, the server returns an error. (required)
182 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.
183 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.
John Asmuth614db982014-04-24 15:46:26 -0400184
185Returns:
186 An object of the form:
187
188 { # LicesnseAssignment List for a given product/sku for a customer.
Dan O'Mearadd494642020-05-01 07:42:23 -0700189 "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.
John Asmuth614db982014-04-24 15:46:26 -0400190 "items": [ # The LicenseAssignments in this page of results.
Dan O'Mearadd494642020-05-01 07:42:23 -0700191 { # Representation of a license assignment.
192 "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.
John Asmuth614db982014-04-24 15:46:26 -0400193 "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
Dan O'Mearadd494642020-05-01 07:42:23 -0700194 "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.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700195 "productName": "A String", # Display Name of the product.
196 "skuName": "A String", # Display Name of the sku of the product.
John Asmuth614db982014-04-24 15:46:26 -0400197 "etags": "A String", # ETag of the resource.
198 "selfLink": "A String", # Link to this page.
Dan O'Mearadd494642020-05-01 07:42:23 -0700199 "productId": "A String", # A product's unique identifier. For more information about products in this version of the API, see Product and SKU IDs.
John Asmuth614db982014-04-24 15:46:26 -0400200 },
201 ],
202 "kind": "licensing#licenseAssignmentList", # Identifies the resource as a collection of LicenseAssignments.
203 "etag": "A String", # ETag of the resource.
204 }</pre>
205</div>
206
207<div class="method">
208 <code class="details" id="listForProductAndSku">listForProductAndSku(productId, skuId, customerId, pageToken=None, maxResults=None)</code>
Dan O'Mearadd494642020-05-01 07:42:23 -0700209 <pre>List all users assigned licenses for a specific product SKU.
John Asmuth614db982014-04-24 15:46:26 -0400210
211Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700212 productId: string, A product's unique identifier. For more information about products in this version of the API, see Products and SKUs. (required)
213 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)
214 customerId: string, Customer's customerId. A previous version of this API accepted the primary domain name as a value for this field.
215If the customer is suspended, the server returns an error. (required)
216 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.
217 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.
John Asmuth614db982014-04-24 15:46:26 -0400218
219Returns:
220 An object of the form:
221
222 { # LicesnseAssignment List for a given product/sku for a customer.
Dan O'Mearadd494642020-05-01 07:42:23 -0700223 "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.
John Asmuth614db982014-04-24 15:46:26 -0400224 "items": [ # The LicenseAssignments in this page of results.
Dan O'Mearadd494642020-05-01 07:42:23 -0700225 { # Representation of a license assignment.
226 "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.
John Asmuth614db982014-04-24 15:46:26 -0400227 "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
Dan O'Mearadd494642020-05-01 07:42:23 -0700228 "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.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700229 "productName": "A String", # Display Name of the product.
230 "skuName": "A String", # Display Name of the sku of the product.
John Asmuth614db982014-04-24 15:46:26 -0400231 "etags": "A String", # ETag of the resource.
232 "selfLink": "A String", # Link to this page.
Dan O'Mearadd494642020-05-01 07:42:23 -0700233 "productId": "A String", # A product's unique identifier. For more information about products in this version of the API, see Product and SKU IDs.
John Asmuth614db982014-04-24 15:46:26 -0400234 },
235 ],
236 "kind": "licensing#licenseAssignmentList", # Identifies the resource as a collection of LicenseAssignments.
237 "etag": "A String", # ETag of the resource.
238 }</pre>
239</div>
240
241<div class="method">
242 <code class="details" id="listForProductAndSku_next">listForProductAndSku_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="listForProduct_next">listForProduct_next(previous_request, previous_response)</code>
257 <pre>Retrieves the next page of results.
258
259Args:
260 previous_request: The request for the previous page. (required)
261 previous_response: The response from the request for the previous page. (required)
262
263Returns:
264 A request object that you can call 'execute()' on to request the next
265 page. Returns None if there are no more items in the collection.
266 </pre>
267</div>
268
269<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700270 <code class="details" id="patch">patch(productId, skuId, userId, body=None)</code>
271 <pre>Reassign a user's product SKU with a different SKU in the same product. This method supports patch semantics.
John Asmuth614db982014-04-24 15:46:26 -0400272
273Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700274 productId: string, A product's unique identifier. For more information about products in this version of the API, see Products and SKUs. (required)
275 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)
276 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.
277Since 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.
278If the userId is suspended, the license status changes. (required)
279 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400280 The object takes the form of:
281
Dan O'Mearadd494642020-05-01 07:42:23 -0700282{ # Representation of a license assignment.
283 "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.
John Asmuth614db982014-04-24 15:46:26 -0400284 "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
Dan O'Mearadd494642020-05-01 07:42:23 -0700285 "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.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700286 "productName": "A String", # Display Name of the product.
287 "skuName": "A String", # Display Name of the sku of the product.
John Asmuth614db982014-04-24 15:46:26 -0400288 "etags": "A String", # ETag of the resource.
289 "selfLink": "A String", # Link to this page.
Dan O'Mearadd494642020-05-01 07:42:23 -0700290 "productId": "A String", # A product's unique identifier. For more information about products in this version of the API, see Product and SKU IDs.
John Asmuth614db982014-04-24 15:46:26 -0400291}
292
293
294Returns:
295 An object of the form:
296
Dan O'Mearadd494642020-05-01 07:42:23 -0700297 { # Representation of a license assignment.
298 "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.
John Asmuth614db982014-04-24 15:46:26 -0400299 "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
Dan O'Mearadd494642020-05-01 07:42:23 -0700300 "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.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700301 "productName": "A String", # Display Name of the product.
302 "skuName": "A String", # Display Name of the sku of the product.
John Asmuth614db982014-04-24 15:46:26 -0400303 "etags": "A String", # ETag of the resource.
304 "selfLink": "A String", # Link to this page.
Dan O'Mearadd494642020-05-01 07:42:23 -0700305 "productId": "A String", # A product's unique identifier. For more information about products in this version of the API, see Product and SKU IDs.
John Asmuth614db982014-04-24 15:46:26 -0400306 }</pre>
307</div>
308
309<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700310 <code class="details" id="update">update(productId, skuId, userId, body=None)</code>
311 <pre>Reassign a user's product SKU with a different SKU in the same product.
John Asmuth614db982014-04-24 15:46:26 -0400312
313Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700314 productId: string, A product's unique identifier. For more information about products in this version of the API, see Products and SKUs. (required)
315 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)
316 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.
317Since 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.
318If the userId is suspended, the license status changes. (required)
319 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400320 The object takes the form of:
321
Dan O'Mearadd494642020-05-01 07:42:23 -0700322{ # Representation of a license assignment.
323 "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.
John Asmuth614db982014-04-24 15:46:26 -0400324 "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
Dan O'Mearadd494642020-05-01 07:42:23 -0700325 "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.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700326 "productName": "A String", # Display Name of the product.
327 "skuName": "A String", # Display Name of the sku of the product.
John Asmuth614db982014-04-24 15:46:26 -0400328 "etags": "A String", # ETag of the resource.
329 "selfLink": "A String", # Link to this page.
Dan O'Mearadd494642020-05-01 07:42:23 -0700330 "productId": "A String", # A product's unique identifier. For more information about products in this version of the API, see Product and SKU IDs.
John Asmuth614db982014-04-24 15:46:26 -0400331}
332
333
334Returns:
335 An object of the form:
336
Dan O'Mearadd494642020-05-01 07:42:23 -0700337 { # Representation of a license assignment.
338 "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.
John Asmuth614db982014-04-24 15:46:26 -0400339 "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
Dan O'Mearadd494642020-05-01 07:42:23 -0700340 "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.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700341 "productName": "A String", # Display Name of the product.
342 "skuName": "A String", # Display Name of the sku of the product.
John Asmuth614db982014-04-24 15:46:26 -0400343 "etags": "A String", # ETag of the resource.
344 "selfLink": "A String", # Link to this page.
Dan O'Mearadd494642020-05-01 07:42:23 -0700345 "productId": "A String", # A product's unique identifier. For more information about products in this version of the API, see Product and SKU IDs.
John Asmuth614db982014-04-24 15:46:26 -0400346 }</pre>
347</div>
348
349</body></html>