Enterprise License Manager API . licenseAssignments

close()

Close httplib2 connections.

delete(productId, skuId, userId, x__xgafv=None)

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); }
}

get(productId, skuId, userId, x__xgafv=None)

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.
}

insert(productId, skuId, body=None, x__xgafv=None)

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.
}

listForProduct(productId, customerId, maxResults=None, pageToken=None, x__xgafv=None)

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.
}

listForProductAndSku(productId, skuId, customerId, maxResults=None, pageToken=None, x__xgafv=None)

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.
}

listForProductAndSku_next()

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.
        

listForProduct_next()

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.
        

patch(productId, skuId, userId, body=None, x__xgafv=None)

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.
}

update(productId, skuId, userId, body=None, x__xgafv=None)

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.
}