docs/dyn/androidenterprise_v1.entitlements.html - external/github.com/google/google-api-python-client - Git at Google

 <html><body>
 <style>

 body, h1, h2, h3, div, span, p, pre, a {
   margin: 0;
   padding: 0;
   border: 0;
   font-weight: inherit;
   font-style: inherit;
   font-size: 100%;
   font-family: inherit;
   vertical-align: baseline;
 }

 body {
   font-size: 13px;
   padding: 1em;
 }

 h1 {
   font-size: 26px;
   margin-bottom: 1em;
 }

 h2 {
   font-size: 24px;
   margin-bottom: 1em;
 }

 h3 {
   font-size: 20px;
   margin-bottom: 1em;
   margin-top: 1em;
 }

 pre, code {
   line-height: 1.5;
   font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
 }

 pre {
   margin-top: 0.5em;
 }

 h1, h2, h3, p {
   font-family: Arial, sans serif;
 }

 h1, h2, h3 {
   border-bottom: solid #CCC 1px;
 }

 .toc_element {
   margin-top: 0.5em;
 }

 .firstline {
   margin-left: 2 em;
 }

 .method  {
   margin-top: 1em;
   border: solid 1px #CCC;
   padding: 1em;
   background: #EEE;
 }

 .details {
   font-weight: bold;
   font-size: 14px;
 }

 </style>

 <h1><a href="androidenterprise_v1.html">Google Play EMM API</a> . <a href="androidenterprise_v1.entitlements.html">entitlements</a></h1>
 <h2>Instance Methods</h2>
 <p class="toc_element">
   <code><a href="#delete">delete(enterpriseId, userId, entitlementId, x__xgafv=None)</a></code></p>
 <p class="firstline">Removes an entitlement to an app for a user.</p>
 <p class="toc_element">
   <code><a href="#get">get(enterpriseId, userId, entitlementId, x__xgafv=None)</a></code></p>
 <p class="firstline">Retrieves details of an entitlement.</p>
 <p class="toc_element">
   <code><a href="#list">list(enterpriseId, userId, x__xgafv=None)</a></code></p>
 <p class="firstline">Lists all entitlements for the specified user. Only the ID is set.</p>
 <p class="toc_element">
   <code><a href="#update">update(enterpriseId, userId, entitlementId, body=None, install=None, x__xgafv=None)</a></code></p>
 <p class="firstline">Adds or updates an entitlement to an app for a user.</p>
 <h3>Method Details</h3>
 <div class="method">
     <code class="details" id="delete">delete(enterpriseId, userId, entitlementId, x__xgafv=None)</code>
   <pre>Removes an entitlement to an app for a user.

 Args:
   enterpriseId: string, The ID of the enterprise. (required)
   userId: string, The ID of the user. (required)
   entitlementId: string, The ID of the entitlement (a product ID), e.g. &quot;app:com.google.android.gm&quot;. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
       2 - v2 error format
 </pre>
 </div>

 <div class="method">
     <code class="details" id="get">get(enterpriseId, userId, entitlementId, x__xgafv=None)</code>
   <pre>Retrieves details of an entitlement.

 Args:
   enterpriseId: string, The ID of the enterprise. (required)
   userId: string, The ID of the user. (required)
   entitlementId: string, The ID of the entitlement (a product ID), e.g. &quot;app:com.google.android.gm&quot;. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
       2 - v2 error format

 Returns:
   An object of the form:

     { # The presence of an Entitlements resource indicates that a user has the right
         # to use a particular app. Entitlements are user specific, not device specific.
         # This allows a user with an entitlement to an app to install the app on all
         # their devices. It&#x27;s also possible for a user to hold an entitlement to an app
         # without installing the app on any device.
         #
         # The API can be used to create an entitlement. As an option, you can also use
         # the API to trigger the installation of an app on all a user&#x27;s managed devices
         # at the same time the entitlement is created.
         #
         # If the app is free, creating the entitlement also creates a group license
         # for that app. For paid apps, creating the entitlement consumes one license,
         # and that license remains consumed until the entitlement is removed. If the
         # enterprise hasn&#x27;t purchased enough licenses, then no entitlement is created
         # and the installation fails. An entitlement is also not created for an app if
         # the app requires permissions that the enterprise hasn&#x27;t accepted.
         #
         # If an entitlement is deleted, the app may be uninstalled from a user&#x27;s
         # device. As a best practice, uninstall the app by calling
         # &lt;a class=&quot;method-link&quot; method=&quot;androidenterprise.installs.delete&quot;&gt;
         # Installs.delete()&lt;/a&gt; before deleting the entitlement.
         #
         # Entitlements for apps that a user pays for on an unmanaged profile have
         # &lt;code class=&quot;&quot;&gt;&quot;userPurchase&quot;&lt;/code&gt; as the entitlement reason. These
         # entitlements cannot be removed via the API.
       &quot;reason&quot;: &quot;A String&quot;, # The reason for the entitlement. For example, &lt;code class=&quot;&quot;&gt;&quot;free&quot;&lt;/code&gt;
           # for free apps. This property is temporary: it will be replaced by the &lt;code
           # class=&quot;&quot;&gt;acquisition kind&lt;/code&gt; field of group licenses.
       &quot;productId&quot;: &quot;A String&quot;, # The ID of the product that the entitlement is for. For example,
           # &lt;code&gt;&amp;quot;app:com.google.android.gm&amp;quot;&lt;/code&gt;.
     }</pre>
 </div>

 <div class="method">
     <code class="details" id="list">list(enterpriseId, userId, x__xgafv=None)</code>
   <pre>Lists all entitlements for the specified user. Only the ID is set.

 Args:
   enterpriseId: string, The ID of the enterprise. (required)
   userId: string, The ID of the user. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
       2 - v2 error format

 Returns:
   An object of the form:

     {
     &quot;entitlement&quot;: [ # An entitlement of a user to a product (e.g. an app).
         # For example, a free app that they have installed, or a paid app that they
         # have been allocated a license to.
       { # The presence of an Entitlements resource indicates that a user has the right
             # to use a particular app. Entitlements are user specific, not device specific.
             # This allows a user with an entitlement to an app to install the app on all
             # their devices. It&#x27;s also possible for a user to hold an entitlement to an app
             # without installing the app on any device.
             #
             # The API can be used to create an entitlement. As an option, you can also use
             # the API to trigger the installation of an app on all a user&#x27;s managed devices
             # at the same time the entitlement is created.
             #
             # If the app is free, creating the entitlement also creates a group license
             # for that app. For paid apps, creating the entitlement consumes one license,
             # and that license remains consumed until the entitlement is removed. If the
             # enterprise hasn&#x27;t purchased enough licenses, then no entitlement is created
             # and the installation fails. An entitlement is also not created for an app if
             # the app requires permissions that the enterprise hasn&#x27;t accepted.
             #
             # If an entitlement is deleted, the app may be uninstalled from a user&#x27;s
             # device. As a best practice, uninstall the app by calling
             # &lt;a class=&quot;method-link&quot; method=&quot;androidenterprise.installs.delete&quot;&gt;
             # Installs.delete()&lt;/a&gt; before deleting the entitlement.
             #
             # Entitlements for apps that a user pays for on an unmanaged profile have
             # &lt;code class=&quot;&quot;&gt;&quot;userPurchase&quot;&lt;/code&gt; as the entitlement reason. These
             # entitlements cannot be removed via the API.
           &quot;reason&quot;: &quot;A String&quot;, # The reason for the entitlement. For example, &lt;code class=&quot;&quot;&gt;&quot;free&quot;&lt;/code&gt;
               # for free apps. This property is temporary: it will be replaced by the &lt;code
               # class=&quot;&quot;&gt;acquisition kind&lt;/code&gt; field of group licenses.
           &quot;productId&quot;: &quot;A String&quot;, # The ID of the product that the entitlement is for. For example,
               # &lt;code&gt;&amp;quot;app:com.google.android.gm&amp;quot;&lt;/code&gt;.
         },
     ],
   }</pre>
 </div>

 <div class="method">
     <code class="details" id="update">update(enterpriseId, userId, entitlementId, body=None, install=None, x__xgafv=None)</code>
   <pre>Adds or updates an entitlement to an app for a user.

 Args:
   enterpriseId: string, The ID of the enterprise. (required)
   userId: string, The ID of the user. (required)
   entitlementId: string, The ID of the entitlement (a product ID), e.g. &quot;app:com.google.android.gm&quot;. (required)
   body: object, The request body.
     The object takes the form of:

 { # The presence of an Entitlements resource indicates that a user has the right
       # to use a particular app. Entitlements are user specific, not device specific.
       # This allows a user with an entitlement to an app to install the app on all
       # their devices. It&#x27;s also possible for a user to hold an entitlement to an app
       # without installing the app on any device.
       #
       # The API can be used to create an entitlement. As an option, you can also use
       # the API to trigger the installation of an app on all a user&#x27;s managed devices
       # at the same time the entitlement is created.
       #
       # If the app is free, creating the entitlement also creates a group license
       # for that app. For paid apps, creating the entitlement consumes one license,
       # and that license remains consumed until the entitlement is removed. If the
       # enterprise hasn&#x27;t purchased enough licenses, then no entitlement is created
       # and the installation fails. An entitlement is also not created for an app if
       # the app requires permissions that the enterprise hasn&#x27;t accepted.
       #
       # If an entitlement is deleted, the app may be uninstalled from a user&#x27;s
       # device. As a best practice, uninstall the app by calling
       # &lt;a class=&quot;method-link&quot; method=&quot;androidenterprise.installs.delete&quot;&gt;
       # Installs.delete()&lt;/a&gt; before deleting the entitlement.
       #
       # Entitlements for apps that a user pays for on an unmanaged profile have
       # &lt;code class=&quot;&quot;&gt;&quot;userPurchase&quot;&lt;/code&gt; as the entitlement reason. These
       # entitlements cannot be removed via the API.
     &quot;reason&quot;: &quot;A String&quot;, # The reason for the entitlement. For example, &lt;code class=&quot;&quot;&gt;&quot;free&quot;&lt;/code&gt;
         # for free apps. This property is temporary: it will be replaced by the &lt;code
         # class=&quot;&quot;&gt;acquisition kind&lt;/code&gt; field of group licenses.
     &quot;productId&quot;: &quot;A String&quot;, # The ID of the product that the entitlement is for. For example,
         # &lt;code&gt;&amp;quot;app:com.google.android.gm&amp;quot;&lt;/code&gt;.
   }

   install: boolean, Set to true to also install the product on all the user&#x27;s devices where
 possible. Failure to install on one or more devices will not prevent
 this operation from returning successfully, as long as the entitlement
 was successfully assigned to the user.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
       2 - v2 error format

 Returns:
   An object of the form:

     { # The presence of an Entitlements resource indicates that a user has the right
         # to use a particular app. Entitlements are user specific, not device specific.
         # This allows a user with an entitlement to an app to install the app on all
         # their devices. It&#x27;s also possible for a user to hold an entitlement to an app
         # without installing the app on any device.
         #
         # The API can be used to create an entitlement. As an option, you can also use
         # the API to trigger the installation of an app on all a user&#x27;s managed devices
         # at the same time the entitlement is created.
         #
         # If the app is free, creating the entitlement also creates a group license
         # for that app. For paid apps, creating the entitlement consumes one license,
         # and that license remains consumed until the entitlement is removed. If the
         # enterprise hasn&#x27;t purchased enough licenses, then no entitlement is created
         # and the installation fails. An entitlement is also not created for an app if
         # the app requires permissions that the enterprise hasn&#x27;t accepted.
         #
         # If an entitlement is deleted, the app may be uninstalled from a user&#x27;s
         # device. As a best practice, uninstall the app by calling
         # &lt;a class=&quot;method-link&quot; method=&quot;androidenterprise.installs.delete&quot;&gt;
         # Installs.delete()&lt;/a&gt; before deleting the entitlement.
         #
         # Entitlements for apps that a user pays for on an unmanaged profile have
         # &lt;code class=&quot;&quot;&gt;&quot;userPurchase&quot;&lt;/code&gt; as the entitlement reason. These
         # entitlements cannot be removed via the API.
       &quot;reason&quot;: &quot;A String&quot;, # The reason for the entitlement. For example, &lt;code class=&quot;&quot;&gt;&quot;free&quot;&lt;/code&gt;
           # for free apps. This property is temporary: it will be replaced by the &lt;code
           # class=&quot;&quot;&gt;acquisition kind&lt;/code&gt; field of group licenses.
       &quot;productId&quot;: &quot;A String&quot;, # The ID of the product that the entitlement is for. For example,
           # &lt;code&gt;&amp;quot;app:com.google.android.gm&amp;quot;&lt;/code&gt;.
     }</pre>
 </div>

 </body></html>
	<html><body>
	<style>

	body, h1, h2, h3, div, span, p, pre, a {
	margin: 0;
	padding: 0;
	border: 0;
	font-weight: inherit;
	font-style: inherit;
	font-size: 100%;
	font-family: inherit;
	vertical-align: baseline;
	}

	body {
	font-size: 13px;
	padding: 1em;
	}

	h1 {
	font-size: 26px;
	margin-bottom: 1em;
	}

	h2 {
	font-size: 24px;
	margin-bottom: 1em;
	}

	h3 {
	font-size: 20px;
	margin-bottom: 1em;
	margin-top: 1em;
	}

	pre, code {
	line-height: 1.5;
	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
	}

	pre {
	margin-top: 0.5em;
	}

	h1, h2, h3, p {
	font-family: Arial, sans serif;
	}

	h1, h2, h3 {
	border-bottom: solid #CCC 1px;
	}

	.toc_element {
	margin-top: 0.5em;
	}

	.firstline {
	margin-left: 2 em;
	}

	.method {
	margin-top: 1em;
	border: solid 1px #CCC;
	padding: 1em;
	background: #EEE;
	}

	.details {
	font-weight: bold;
	font-size: 14px;
	}

	</style>

	<h1><a href="androidenterprise_v1.html">Google Play EMM API</a> . <a href="androidenterprise_v1.entitlements.html">entitlements</a></h1>
	<h2>Instance Methods</h2>
	<p class="toc_element">
	<code><a href="#delete">delete(enterpriseId, userId, entitlementId, x__xgafv=None)</a></code></p>
	<p class="firstline">Removes an entitlement to an app for a user.</p>
	<p class="toc_element">
	<code><a href="#get">get(enterpriseId, userId, entitlementId, x__xgafv=None)</a></code></p>
	<p class="firstline">Retrieves details of an entitlement.</p>
	<p class="toc_element">
	<code><a href="#list">list(enterpriseId, userId, x__xgafv=None)</a></code></p>
	<p class="firstline">Lists all entitlements for the specified user. Only the ID is set.</p>
	<p class="toc_element">
	<code><a href="#update">update(enterpriseId, userId, entitlementId, body=None, install=None, x__xgafv=None)</a></code></p>
	<p class="firstline">Adds or updates an entitlement to an app for a user.</p>
	<h3>Method Details</h3>
	<div class="method">
	<code class="details" id="delete">delete(enterpriseId, userId, entitlementId, x__xgafv=None)</code>
	<pre>Removes an entitlement to an app for a user.

	Args:
	enterpriseId: string, The ID of the enterprise. (required)
	userId: string, The ID of the user. (required)
	entitlementId: string, The ID of the entitlement (a product ID), e.g. "app:com.google.android.gm". (required)
	x__xgafv: string, V1 error format.
	Allowed values
	1 - v1 error format
	2 - v2 error format
	</pre>
	</div>

	<div class="method">
	<code class="details" id="get">get(enterpriseId, userId, entitlementId, x__xgafv=None)</code>
	<pre>Retrieves details of an entitlement.

	Args:
	enterpriseId: string, The ID of the enterprise. (required)
	userId: string, The ID of the user. (required)
	entitlementId: string, The ID of the entitlement (a product ID), e.g. "app:com.google.android.gm". (required)
	x__xgafv: string, V1 error format.
	Allowed values
	1 - v1 error format
	2 - v2 error format

	Returns:
	An object of the form:

	{ # The presence of an Entitlements resource indicates that a user has the right
	# to use a particular app. Entitlements are user specific, not device specific.
	# This allows a user with an entitlement to an app to install the app on all
	# their devices. It's also possible for a user to hold an entitlement to an app
	# without installing the app on any device.
	#
	# The API can be used to create an entitlement. As an option, you can also use
	# the API to trigger the installation of an app on all a user's managed devices
	# at the same time the entitlement is created.
	#
	# If the app is free, creating the entitlement also creates a group license
	# for that app. For paid apps, creating the entitlement consumes one license,
	# and that license remains consumed until the entitlement is removed. If the
	# enterprise hasn't purchased enough licenses, then no entitlement is created
	# and the installation fails. An entitlement is also not created for an app if
	# the app requires permissions that the enterprise hasn't accepted.
	#
	# If an entitlement is deleted, the app may be uninstalled from a user's
	# device. As a best practice, uninstall the app by calling
	# <a class="method-link" method="androidenterprise.installs.delete">
	# Installs.delete()</a> before deleting the entitlement.
	#
	# Entitlements for apps that a user pays for on an unmanaged profile have
	# <code class="">"userPurchase"</code> as the entitlement reason. These
	# entitlements cannot be removed via the API.
	"reason": "A String", # The reason for the entitlement. For example, <code class="">"free"</code>
	# for free apps. This property is temporary: it will be replaced by the <code
	# class="">acquisition kind</code> field of group licenses.
	"productId": "A String", # The ID of the product that the entitlement is for. For example,
	# <code>&quot;app:com.google.android.gm&quot;</code>.
	}</pre>
	</div>

	<div class="method">
	<code class="details" id="list">list(enterpriseId, userId, x__xgafv=None)</code>
	<pre>Lists all entitlements for the specified user. Only the ID is set.

	Args:
	enterpriseId: string, The ID of the enterprise. (required)
	userId: string, The ID of the user. (required)
	x__xgafv: string, V1 error format.
	Allowed values
	1 - v1 error format
	2 - v2 error format

	Returns:
	An object of the form:

	{
	"entitlement": [ # An entitlement of a user to a product (e.g. an app).
	# For example, a free app that they have installed, or a paid app that they
	# have been allocated a license to.
	{ # The presence of an Entitlements resource indicates that a user has the right
	# to use a particular app. Entitlements are user specific, not device specific.
	# This allows a user with an entitlement to an app to install the app on all
	# their devices. It's also possible for a user to hold an entitlement to an app
	# without installing the app on any device.
	#
	# The API can be used to create an entitlement. As an option, you can also use
	# the API to trigger the installation of an app on all a user's managed devices
	# at the same time the entitlement is created.
	#
	# If the app is free, creating the entitlement also creates a group license
	# for that app. For paid apps, creating the entitlement consumes one license,
	# and that license remains consumed until the entitlement is removed. If the
	# enterprise hasn't purchased enough licenses, then no entitlement is created
	# and the installation fails. An entitlement is also not created for an app if
	# the app requires permissions that the enterprise hasn't accepted.
	#
	# If an entitlement is deleted, the app may be uninstalled from a user's
	# device. As a best practice, uninstall the app by calling
	# <a class="method-link" method="androidenterprise.installs.delete">
	# Installs.delete()</a> before deleting the entitlement.
	#
	# Entitlements for apps that a user pays for on an unmanaged profile have
	# <code class="">"userPurchase"</code> as the entitlement reason. These
	# entitlements cannot be removed via the API.
	"reason": "A String", # The reason for the entitlement. For example, <code class="">"free"</code>
	# for free apps. This property is temporary: it will be replaced by the <code
	# class="">acquisition kind</code> field of group licenses.
	"productId": "A String", # The ID of the product that the entitlement is for. For example,
	# <code>&quot;app:com.google.android.gm&quot;</code>.
	},
	],
	}</pre>
	</div>

	<div class="method">
	<code class="details" id="update">update(enterpriseId, userId, entitlementId, body=None, install=None, x__xgafv=None)</code>
	<pre>Adds or updates an entitlement to an app for a user.

	Args:
	enterpriseId: string, The ID of the enterprise. (required)
	userId: string, The ID of the user. (required)
	entitlementId: string, The ID of the entitlement (a product ID), e.g. "app:com.google.android.gm". (required)
	body: object, The request body.
	The object takes the form of:

	{ # The presence of an Entitlements resource indicates that a user has the right
	# to use a particular app. Entitlements are user specific, not device specific.
	# This allows a user with an entitlement to an app to install the app on all
	# their devices. It's also possible for a user to hold an entitlement to an app
	# without installing the app on any device.
	#
	# The API can be used to create an entitlement. As an option, you can also use
	# the API to trigger the installation of an app on all a user's managed devices
	# at the same time the entitlement is created.
	#
	# If the app is free, creating the entitlement also creates a group license
	# for that app. For paid apps, creating the entitlement consumes one license,
	# and that license remains consumed until the entitlement is removed. If the
	# enterprise hasn't purchased enough licenses, then no entitlement is created
	# and the installation fails. An entitlement is also not created for an app if
	# the app requires permissions that the enterprise hasn't accepted.
	#
	# If an entitlement is deleted, the app may be uninstalled from a user's
	# device. As a best practice, uninstall the app by calling
	# <a class="method-link" method="androidenterprise.installs.delete">
	# Installs.delete()</a> before deleting the entitlement.
	#
	# Entitlements for apps that a user pays for on an unmanaged profile have
	# <code class="">"userPurchase"</code> as the entitlement reason. These
	# entitlements cannot be removed via the API.
	"reason": "A String", # The reason for the entitlement. For example, <code class="">"free"</code>
	# for free apps. This property is temporary: it will be replaced by the <code
	# class="">acquisition kind</code> field of group licenses.
	"productId": "A String", # The ID of the product that the entitlement is for. For example,
	# <code>&quot;app:com.google.android.gm&quot;</code>.
	}

	install: boolean, Set to true to also install the product on all the user's devices where
	possible. Failure to install on one or more devices will not prevent
	this operation from returning successfully, as long as the entitlement
	was successfully assigned to the user.
	x__xgafv: string, V1 error format.
	Allowed values
	1 - v1 error format
	2 - v2 error format

	Returns:
	An object of the form:

	{ # The presence of an Entitlements resource indicates that a user has the right
	# to use a particular app. Entitlements are user specific, not device specific.
	# This allows a user with an entitlement to an app to install the app on all
	# their devices. It's also possible for a user to hold an entitlement to an app
	# without installing the app on any device.
	#
	# The API can be used to create an entitlement. As an option, you can also use
	# the API to trigger the installation of an app on all a user's managed devices
	# at the same time the entitlement is created.
	#
	# If the app is free, creating the entitlement also creates a group license
	# for that app. For paid apps, creating the entitlement consumes one license,
	# and that license remains consumed until the entitlement is removed. If the
	# enterprise hasn't purchased enough licenses, then no entitlement is created
	# and the installation fails. An entitlement is also not created for an app if
	# the app requires permissions that the enterprise hasn't accepted.
	#
	# If an entitlement is deleted, the app may be uninstalled from a user's
	# device. As a best practice, uninstall the app by calling
	# <a class="method-link" method="androidenterprise.installs.delete">
	# Installs.delete()</a> before deleting the entitlement.
	#
	# Entitlements for apps that a user pays for on an unmanaged profile have
	# <code class="">"userPurchase"</code> as the entitlement reason. These
	# entitlements cannot be removed via the API.
	"reason": "A String", # The reason for the entitlement. For example, <code class="">"free"</code>
	# for free apps. This property is temporary: it will be replaced by the <code
	# class="">acquisition kind</code> field of group licenses.
	"productId": "A String", # The ID of the product that the entitlement is for. For example,
	# <code>&quot;app:com.google.android.gm&quot;</code>.
	}</pre>
	</div>

	</body></html>