Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 98b51f044ede8b9b24e584ab9680e3f35f4bd469 / . / docs / dyn / androidenterprise_v1.entitlements.html
blob: 1ffc86635ee20de5d33ab703b97de5a3dfd987ad [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">
87 <code><a href="#patch">patch(enterpriseId, userId, entitlementId, body, install=None)</a></code></p>
88<p class="firstline">Adds or updates an entitlement to an app for a user. This method supports patch semantics.</p>
89<p class="toc_element">
90 <code><a href="#update">update(enterpriseId, userId, entitlementId, body, install=None)</a></code></p>
91<p class="firstline">Adds or updates an entitlement to an app for a user.</p>
92<h3>Method Details</h3>
93<div class="method">
94 <code class="details" id="delete">delete(enterpriseId, userId, entitlementId)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]95 <pre>Removes an entitlement to an app for a user.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]96
97Args:
98 enterpriseId: string, The ID of the enterprise. (required)
99 userId: string, The ID of the user. (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]100 entitlementId: string, The ID of the entitlement (a product ID), e.g. "app:com.google.android.gm". (required)
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]101</pre>
102</div>
103
104<div class="method">
105 <code class="details" id="get">get(enterpriseId, userId, entitlementId)</code>
106 <pre>Retrieves details of an entitlement.
107
108Args:
109 enterpriseId: string, The ID of the enterprise. (required)
110 userId: string, The ID of the user. (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]111 entitlementId: string, The ID of the entitlement (a product ID), e.g. "app:com.google.android.gm". (required)
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]112
113Returns:
114 An object of the form:
115
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]116 { # 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.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]117 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]118 # 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.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]119 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]120 # 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.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]121 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]122 # If an entitlement is deleted, the app may be uninstalled from a user's device. As a best practice, uninstall the app by calling Installs.delete() before deleting the entitlement.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]123 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]124 # Entitlements for apps that a user pays for on an unmanaged profile have "userPurchase" as the entitlement reason. These entitlements cannot be removed via the API.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]125 "kind": "androidenterprise#entitlement", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#entitlement".
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]126 "reason": "A String", # The reason for the entitlement. For example, "free" for free apps. This property is temporary: it will be replaced by the acquisition kind field of group licenses.
127 "productId": "A String", # The ID of the product that the entitlement is for. For example, "app:com.google.android.gm".
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]128 }</pre>
129</div>
130
131<div class="method">
132 <code class="details" id="list">list(enterpriseId, userId)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]133 <pre>Lists all entitlements for the specified user. Only the ID is set.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]134
135Args:
136 enterpriseId: string, The ID of the enterprise. (required)
137 userId: string, The ID of the user. (required)
138
139Returns:
140 An object of the form:
141
142 { # The entitlement resources for the user.
143 "kind": "androidenterprise#entitlementsListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#entitlementsListResponse".
144 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]145 { # 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.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]146 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]147 # 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.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]148 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]149 # 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.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]150 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]151 # If an entitlement is deleted, the app may be uninstalled from a user's device. As a best practice, uninstall the app by calling Installs.delete() before deleting the entitlement.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]152 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]153 # Entitlements for apps that a user pays for on an unmanaged profile have "userPurchase" as the entitlement reason. These entitlements cannot be removed via the API.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]154 "kind": "androidenterprise#entitlement", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#entitlement".
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]155 "reason": "A String", # The reason for the entitlement. For example, "free" for free apps. This property is temporary: it will be replaced by the acquisition kind field of group licenses.
156 "productId": "A String", # The ID of the product that the entitlement is for. For example, "app:com.google.android.gm".
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]157 },
158 ],
159 }</pre>
160</div>
161
162<div class="method">
163 <code class="details" id="patch">patch(enterpriseId, userId, entitlementId, body, install=None)</code>
164 <pre>Adds or updates an entitlement to an app for a user. This method supports patch semantics.
165
166Args:
167 enterpriseId: string, The ID of the enterprise. (required)
168 userId: string, The ID of the user. (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]169 entitlementId: string, The ID of the entitlement (a product ID), e.g. "app:com.google.android.gm". (required)
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]170 body: object, The request body. (required)
171 The object takes the form of:
172
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]173{ # 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.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]174 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]175 # 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.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]176 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]177 # 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.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]178 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]179 # If an entitlement is deleted, the app may be uninstalled from a user's device. As a best practice, uninstall the app by calling Installs.delete() before deleting the entitlement.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]180 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]181 # Entitlements for apps that a user pays for on an unmanaged profile have "userPurchase" as the entitlement reason. These entitlements cannot be removed via the API.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]182 "kind": "androidenterprise#entitlement", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#entitlement".
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]183 "reason": "A String", # The reason for the entitlement. For example, "free" for free apps. This property is temporary: it will be replaced by the acquisition kind field of group licenses.
184 "productId": "A String", # The ID of the product that the entitlement is for. For example, "app:com.google.android.gm".
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]185 }
186
187 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.
188
189Returns:
190 An object of the form:
191
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]192 { # 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.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]193 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]194 # 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.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]195 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]196 # 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.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]197 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]198 # If an entitlement is deleted, the app may be uninstalled from a user's device. As a best practice, uninstall the app by calling Installs.delete() before deleting the entitlement.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]199 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]200 # Entitlements for apps that a user pays for on an unmanaged profile have "userPurchase" as the entitlement reason. These entitlements cannot be removed via the API.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]201 "kind": "androidenterprise#entitlement", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#entitlement".
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]202 "reason": "A String", # The reason for the entitlement. For example, "free" for free apps. This property is temporary: it will be replaced by the acquisition kind field of group licenses.
203 "productId": "A String", # The ID of the product that the entitlement is for. For example, "app:com.google.android.gm".
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]204 }</pre>
205</div>
206
207<div class="method">
208 <code class="details" id="update">update(enterpriseId, userId, entitlementId, body, install=None)</code>
209 <pre>Adds or updates an entitlement to an app for a user.
210
211Args:
212 enterpriseId: string, The ID of the enterprise. (required)
213 userId: string, The ID of the user. (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]214 entitlementId: string, The ID of the entitlement (a product ID), e.g. "app:com.google.android.gm". (required)
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]215 body: object, The request body. (required)
216 The object takes the form of:
217
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]218{ # 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.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]219 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]220 # 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.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]221 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]222 # 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.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]223 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]224 # If an entitlement is deleted, the app may be uninstalled from a user's device. As a best practice, uninstall the app by calling Installs.delete() before deleting the entitlement.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]225 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]226 # Entitlements for apps that a user pays for on an unmanaged profile have "userPurchase" as the entitlement reason. These entitlements cannot be removed via the API.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]227 "kind": "androidenterprise#entitlement", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#entitlement".
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]228 "reason": "A String", # The reason for the entitlement. For example, "free" for free apps. This property is temporary: it will be replaced by the acquisition kind field of group licenses.
229 "productId": "A String", # The ID of the product that the entitlement is for. For example, "app:com.google.android.gm".
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]230 }
231
232 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.
233
234Returns:
235 An object of the form:
236
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]237 { # 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.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]238 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]239 # 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.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]240 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]241 # 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.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]242 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]243 # If an entitlement is deleted, the app may be uninstalled from a user's device. As a best practice, uninstall the app by calling Installs.delete() before deleting the entitlement.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]244 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]245 # Entitlements for apps that a user pays for on an unmanaged profile have "userPurchase" as the entitlement reason. These entitlements cannot be removed via the API.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]246 "kind": "androidenterprise#entitlement", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#entitlement".
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]247 "reason": "A String", # The reason for the entitlement. For example, "free" for free apps. This property is temporary: it will be replaced by the acquisition kind field of group licenses.
248 "productId": "A String", # The ID of the product that the entitlement is for. For example, "app:com.google.android.gm".
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]249 }</pre>
250</div>
251
252</body></html>