Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c72efbc6b71c963997c5728d471c04ab33d95e4f / . / docs / dyn / androidenterprise_v1.entitlements.html
blob: 7affcd42ad7c991b874b26c8ee1fcc4311b19cc9 [file] [log] [blame]
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]75<h1><a href="androidenterprise_v1.html">Google Play EMM API</a> . <a href="androidenterprise_v1.entitlements.html">entitlements</a></h1>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(enterpriseId, userId, entitlementId)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]79<p class="firstline">Removes an entitlement to an app for a user.</p>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]80<p class="toc_element">
81 <code><a href="#get">get(enterpriseId, userId, entitlementId)</a></code></p>
82<p class="firstline">Retrieves details of an entitlement.</p>
83<p class="toc_element">
84 <code><a href="#list">list(enterpriseId, userId)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]85<p class="firstline">Lists all entitlements for the specified user. Only the ID is set.</p>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]86<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]87 <code><a href="#update">update(enterpriseId, userId, entitlementId, body=None, install=None)</a></code></p>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]88<p class="firstline">Adds or updates an entitlement to an app for a user.</p>
89<h3>Method Details</h3>
90<div class="method">
91 <code class="details" id="delete">delete(enterpriseId, userId, entitlementId)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]92 <pre>Removes an entitlement to an app for a user.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]93
94Args:
95 enterpriseId: string, The ID of the enterprise. (required)
96 userId: string, The ID of the user. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]97 entitlementId: string, The ID of the entitlement (a product ID), e.g. &quot;app:com.google.android.gm&quot;. (required)
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]98</pre>
99</div>
100
101<div class="method">
102 <code class="details" id="get">get(enterpriseId, userId, entitlementId)</code>
103 <pre>Retrieves details of an entitlement.
104
105Args:
106 enterpriseId: string, The ID of the enterprise. (required)
107 userId: string, The ID of the user. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]108 entitlementId: string, The ID of the entitlement (a product ID), e.g. &quot;app:com.google.android.gm&quot;. (required)
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]109
110Returns:
111 An object of the form:
112
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]113 { # 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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]114 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]115 # 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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]116 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]117 # 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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]118 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]119 # 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 Installs.delete() before deleting the entitlement.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]120 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]121 # Entitlements for apps that a user pays for on an unmanaged profile have &quot;userPurchase&quot; as the entitlement reason. These entitlements cannot be removed via the API.
122 &quot;kind&quot;: &quot;androidenterprise#entitlement&quot;,
123 &quot;productId&quot;: &quot;A String&quot;, # The ID of the product that the entitlement is for. For example, &quot;app:com.google.android.gm&quot;.
124 &quot;reason&quot;: &quot;A String&quot;, # The reason for the entitlement. For example, &quot;free&quot; for free apps. This property is temporary: it will be replaced by the acquisition kind field of group licenses.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]125 }</pre>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]126</div>
127
128<div class="method">
129 <code class="details" id="list">list(enterpriseId, userId)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]130 <pre>Lists all entitlements for the specified user. Only the ID is set.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]131
132Args:
133 enterpriseId: string, The ID of the enterprise. (required)
134 userId: string, The ID of the user. (required)
135
136Returns:
137 An object of the form:
138
139 { # The entitlement resources for the user.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]140 &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.
141 { # 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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]142 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]143 # 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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]144 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]145 # 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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]146 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]147 # 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 Installs.delete() before deleting the entitlement.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]148 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]149 # Entitlements for apps that a user pays for on an unmanaged profile have &quot;userPurchase&quot; as the entitlement reason. These entitlements cannot be removed via the API.
150 &quot;kind&quot;: &quot;androidenterprise#entitlement&quot;,
151 &quot;productId&quot;: &quot;A String&quot;, # The ID of the product that the entitlement is for. For example, &quot;app:com.google.android.gm&quot;.
152 &quot;reason&quot;: &quot;A String&quot;, # The reason for the entitlement. For example, &quot;free&quot; for free apps. This property is temporary: it will be replaced by the acquisition kind field of group licenses.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]153 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]154 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]155 &quot;kind&quot;: &quot;androidenterprise#entitlementsListResponse&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;androidenterprise#entitlementsListResponse&quot;.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]156 }</pre>
157</div>
158
159<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]160 <code class="details" id="update">update(enterpriseId, userId, entitlementId, body=None, install=None)</code>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]161 <pre>Adds or updates an entitlement to an app for a user.
162
163Args:
164 enterpriseId: string, The ID of the enterprise. (required)
165 userId: string, The ID of the user. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]166 entitlementId: string, The ID of the entitlement (a product ID), e.g. &quot;app:com.google.android.gm&quot;. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]167 body: object, The request body.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]168 The object takes the form of:
169
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]170{ # 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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]171 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]172 # 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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]173 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]174 # 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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]175 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]176 # 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 Installs.delete() before deleting the entitlement.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]177 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]178 # Entitlements for apps that a user pays for on an unmanaged profile have &quot;userPurchase&quot; as the entitlement reason. These entitlements cannot be removed via the API.
179 &quot;kind&quot;: &quot;androidenterprise#entitlement&quot;,
180 &quot;productId&quot;: &quot;A String&quot;, # The ID of the product that the entitlement is for. For example, &quot;app:com.google.android.gm&quot;.
181 &quot;reason&quot;: &quot;A String&quot;, # The reason for the entitlement. For example, &quot;free&quot; for free apps. This property is temporary: it will be replaced by the acquisition kind field of group licenses.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]182}
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]183
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]184 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.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]185
186Returns:
187 An object of the form:
188
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]189 { # 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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]190 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]191 # 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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]192 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]193 # 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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]194 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]195 # 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 Installs.delete() before deleting the entitlement.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]196 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]197 # Entitlements for apps that a user pays for on an unmanaged profile have &quot;userPurchase&quot; as the entitlement reason. These entitlements cannot be removed via the API.
198 &quot;kind&quot;: &quot;androidenterprise#entitlement&quot;,
199 &quot;productId&quot;: &quot;A String&quot;, # The ID of the product that the entitlement is for. For example, &quot;app:com.google.android.gm&quot;.
200 &quot;reason&quot;: &quot;A String&quot;, # The reason for the entitlement. For example, &quot;free&quot; for free apps. This property is temporary: it will be replaced by the acquisition kind field of group licenses.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]201 }</pre>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]202</div>
203
204</body></html>