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="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#delete">delete(productId, skuId, userId, x__xgafv=None)</a></code></p> 82<p class="firstline">Revoke a license.</p> 83<p class="toc_element"> 84 <code><a href="#get">get(productId, skuId, userId, x__xgafv=None)</a></code></p> 85<p class="firstline">Get a specific user's license by product SKU.</p> 86<p class="toc_element"> 87 <code><a href="#insert">insert(productId, skuId, body=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Assign a license.</p> 89<p class="toc_element"> 90 <code><a href="#listForProduct">listForProduct(productId, customerId, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p> 91<p class="firstline">List all users assigned licenses for a specific product SKU.</p> 92<p class="toc_element"> 93 <code><a href="#listForProductAndSku">listForProductAndSku(productId, skuId, customerId, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p> 94<p class="firstline">List all users assigned licenses for a specific product SKU.</p> 95<p class="toc_element"> 96 <code><a href="#listForProductAndSku_next">listForProductAndSku_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="#listForProduct_next">listForProduct_next(previous_request, previous_response)</a></code></p> 100<p class="firstline">Retrieves the next page of results.</p> 101<p class="toc_element"> 102 <code><a href="#patch">patch(productId, skuId, userId, body=None, x__xgafv=None)</a></code></p> 103<p class="firstline">Reassign a user's product SKU with a different SKU in the same product. This method supports patch semantics.</p> 104<p class="toc_element"> 105 <code><a href="#update">update(productId, skuId, userId, body=None, x__xgafv=None)</a></code></p> 106<p class="firstline">Reassign a user's product SKU with a different SKU in the same product.</p> 107<h3>Method Details</h3> 108<div class="method"> 109 <code class="details" id="close">close()</code> 110 <pre>Close httplib2 connections.</pre> 111</div> 112 113<div class="method"> 114 <code class="details" id="delete">delete(productId, skuId, userId, x__xgafv=None)</code> 115 <pre>Revoke a license. 116 117Args: 118 productId: string, A product's unique identifier. For more information about products in this version of the API, see Products and SKUs. (required) 119 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) 120 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) 121 x__xgafv: string, V1 error format. 122 Allowed values 123 1 - v1 error format 124 2 - v2 error format 125 126Returns: 127 An object of the form: 128 129 { # 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); } The JSON representation for `Empty` is empty JSON object `{}`. 130}</pre> 131</div> 132 133<div class="method"> 134 <code class="details" id="get">get(productId, skuId, userId, x__xgafv=None)</code> 135 <pre>Get a specific user's license by product SKU. 136 137Args: 138 productId: string, A product's unique identifier. For more information about products in this version of the API, see Products and SKUs. (required) 139 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) 140 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) 141 x__xgafv: string, V1 error format. 142 Allowed values 143 1 - v1 error format 144 2 - v2 error format 145 146Returns: 147 An object of the form: 148 149 { # Representation of a license assignment. 150 "etags": "A String", # ETag of the resource. 151 "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment, which is `licensing#licenseAssignment`. 152 "productId": "A String", # A product's unique identifier. For more information about products in this version of the API, see Product and SKU IDs. 153 "productName": "A String", # Display Name of the product. 154 "selfLink": "A String", # Link to this page. 155 "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. 156 "skuName": "A String", # Display Name of the sku of the product. 157 "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. 158}</pre> 159</div> 160 161<div class="method"> 162 <code class="details" id="insert">insert(productId, skuId, body=None, x__xgafv=None)</code> 163 <pre>Assign a license. 164 165Args: 166 productId: string, A product's unique identifier. For more information about products in this version of the API, see Products and SKUs. (required) 167 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) 168 body: object, The request body. 169 The object takes the form of: 170 171{ # Representation of a license assignment. 172 "userId": "A String", # Email id of the user 173} 174 175 x__xgafv: string, V1 error format. 176 Allowed values 177 1 - v1 error format 178 2 - v2 error format 179 180Returns: 181 An object of the form: 182 183 { # Representation of a license assignment. 184 "etags": "A String", # ETag of the resource. 185 "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment, which is `licensing#licenseAssignment`. 186 "productId": "A String", # A product's unique identifier. For more information about products in this version of the API, see Product and SKU IDs. 187 "productName": "A String", # Display Name of the product. 188 "selfLink": "A String", # Link to this page. 189 "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. 190 "skuName": "A String", # Display Name of the sku of the product. 191 "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. 192}</pre> 193</div> 194 195<div class="method"> 196 <code class="details" id="listForProduct">listForProduct(productId, customerId, maxResults=None, pageToken=None, x__xgafv=None)</code> 197 <pre>List all users assigned licenses for a specific product SKU. 198 199Args: 200 productId: string, A product's unique identifier. For more information about products in this version of the API, see Products and SKUs. (required) 201 customerId: string, Customer's `customerId`. A previous version of this API accepted the primary domain name as a value for this field. If the customer is suspended, the server returns an error. (required) 202 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. 203 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. 204 x__xgafv: string, V1 error format. 205 Allowed values 206 1 - v1 error format 207 2 - v2 error format 208 209Returns: 210 An object of the form: 211 212 { 213 "etag": "A String", # ETag of the resource. 214 "items": [ # The LicenseAssignments in this page of results. 215 { # Representation of a license assignment. 216 "etags": "A String", # ETag of the resource. 217 "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment, which is `licensing#licenseAssignment`. 218 "productId": "A String", # A product's unique identifier. For more information about products in this version of the API, see Product and SKU IDs. 219 "productName": "A String", # Display Name of the product. 220 "selfLink": "A String", # Link to this page. 221 "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. 222 "skuName": "A String", # Display Name of the sku of the product. 223 "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. 224 }, 225 ], 226 "kind": "licensing#licenseAssignmentList", # Identifies the resource as a collection of LicenseAssignments. 227 "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. 228}</pre> 229</div> 230 231<div class="method"> 232 <code class="details" id="listForProductAndSku">listForProductAndSku(productId, skuId, customerId, maxResults=None, pageToken=None, x__xgafv=None)</code> 233 <pre>List all users assigned licenses for a specific product SKU. 234 235Args: 236 productId: string, A product's unique identifier. For more information about products in this version of the API, see Products and SKUs. (required) 237 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) 238 customerId: string, Customer's `customerId`. A previous version of this API accepted the primary domain name as a value for this field. If the customer is suspended, the server returns an error. (required) 239 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. 240 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. 241 x__xgafv: string, V1 error format. 242 Allowed values 243 1 - v1 error format 244 2 - v2 error format 245 246Returns: 247 An object of the form: 248 249 { 250 "etag": "A String", # ETag of the resource. 251 "items": [ # The LicenseAssignments in this page of results. 252 { # Representation of a license assignment. 253 "etags": "A String", # ETag of the resource. 254 "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment, which is `licensing#licenseAssignment`. 255 "productId": "A String", # A product's unique identifier. For more information about products in this version of the API, see Product and SKU IDs. 256 "productName": "A String", # Display Name of the product. 257 "selfLink": "A String", # Link to this page. 258 "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. 259 "skuName": "A String", # Display Name of the sku of the product. 260 "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. 261 }, 262 ], 263 "kind": "licensing#licenseAssignmentList", # Identifies the resource as a collection of LicenseAssignments. 264 "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. 265}</pre> 266</div> 267 268<div class="method"> 269 <code class="details" id="listForProductAndSku_next">listForProductAndSku_next(previous_request, previous_response)</code> 270 <pre>Retrieves the next page of results. 271 272Args: 273 previous_request: The request for the previous page. (required) 274 previous_response: The response from the request for the previous page. (required) 275 276Returns: 277 A request object that you can call 'execute()' on to request the next 278 page. Returns None if there are no more items in the collection. 279 </pre> 280</div> 281 282<div class="method"> 283 <code class="details" id="listForProduct_next">listForProduct_next(previous_request, previous_response)</code> 284 <pre>Retrieves the next page of results. 285 286Args: 287 previous_request: The request for the previous page. (required) 288 previous_response: The response from the request for the previous page. (required) 289 290Returns: 291 A request object that you can call 'execute()' on to request the next 292 page. Returns None if there are no more items in the collection. 293 </pre> 294</div> 295 296<div class="method"> 297 <code class="details" id="patch">patch(productId, skuId, userId, body=None, x__xgafv=None)</code> 298 <pre>Reassign a user's product SKU with a different SKU in the same product. This method supports patch semantics. 299 300Args: 301 productId: string, A product's unique identifier. For more information about products in this version of the API, see Products and SKUs. (required) 302 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) 303 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) 304 body: object, The request body. 305 The object takes the form of: 306 307{ # Representation of a license assignment. 308 "etags": "A String", # ETag of the resource. 309 "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment, which is `licensing#licenseAssignment`. 310 "productId": "A String", # A product's unique identifier. For more information about products in this version of the API, see Product and SKU IDs. 311 "productName": "A String", # Display Name of the product. 312 "selfLink": "A String", # Link to this page. 313 "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. 314 "skuName": "A String", # Display Name of the sku of the product. 315 "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. 316} 317 318 x__xgafv: string, V1 error format. 319 Allowed values 320 1 - v1 error format 321 2 - v2 error format 322 323Returns: 324 An object of the form: 325 326 { # Representation of a license assignment. 327 "etags": "A String", # ETag of the resource. 328 "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment, which is `licensing#licenseAssignment`. 329 "productId": "A String", # A product's unique identifier. For more information about products in this version of the API, see Product and SKU IDs. 330 "productName": "A String", # Display Name of the product. 331 "selfLink": "A String", # Link to this page. 332 "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. 333 "skuName": "A String", # Display Name of the sku of the product. 334 "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. 335}</pre> 336</div> 337 338<div class="method"> 339 <code class="details" id="update">update(productId, skuId, userId, body=None, x__xgafv=None)</code> 340 <pre>Reassign a user's product SKU with a different SKU in the same product. 341 342Args: 343 productId: string, A product's unique identifier. For more information about products in this version of the API, see Products and SKUs. (required) 344 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) 345 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) 346 body: object, The request body. 347 The object takes the form of: 348 349{ # Representation of a license assignment. 350 "etags": "A String", # ETag of the resource. 351 "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment, which is `licensing#licenseAssignment`. 352 "productId": "A String", # A product's unique identifier. For more information about products in this version of the API, see Product and SKU IDs. 353 "productName": "A String", # Display Name of the product. 354 "selfLink": "A String", # Link to this page. 355 "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. 356 "skuName": "A String", # Display Name of the sku of the product. 357 "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. 358} 359 360 x__xgafv: string, V1 error format. 361 Allowed values 362 1 - v1 error format 363 2 - v2 error format 364 365Returns: 366 An object of the form: 367 368 { # Representation of a license assignment. 369 "etags": "A String", # ETag of the resource. 370 "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment, which is `licensing#licenseAssignment`. 371 "productId": "A String", # A product's unique identifier. For more information about products in this version of the API, see Product and SKU IDs. 372 "productName": "A String", # Display Name of the product. 373 "selfLink": "A String", # Link to this page. 374 "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. 375 "skuName": "A String", # Display Name of the sku of the product. 376 "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. 377}</pre> 378</div> 379 380</body></html>