Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 5cbe5baf3fad3d67e05b9387e8d81de7ce99aeb9 / . / docs / dyn / androidenterprise_v1.users.html
blob: 41c87b67c7038d64533696b342a242c542cd39a9 [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
75<h1><a href="androidenterprise_v1.html">Google Play MDM API</a> . <a href="androidenterprise_v1.users.html">users</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#generateToken">generateToken(enterpriseId, userId)</a></code></p>
79<p class="firstline">Generates a token (activation code) to allow this user to configure their work account in the Android Setup Wizard. Revokes any previously generated token.</p>
80<p class="toc_element">
81 <code><a href="#get">get(enterpriseId, userId)</a></code></p>
82<p class="firstline">Retrieves a user's details.</p>
83<p class="toc_element">
84 <code><a href="#list">list(enterpriseId, email)</a></code></p>
85<p class="firstline">Looks up a user by email address.</p>
86<p class="toc_element">
87 <code><a href="#revokeToken">revokeToken(enterpriseId, userId)</a></code></p>
88<p class="firstline">Revokes a previously generated token (activation code) for the user.</p>
89<h3>Method Details</h3>
90<div class="method">
91 <code class="details" id="generateToken">generateToken(enterpriseId, userId)</code>
92 <pre>Generates a token (activation code) to allow this user to configure their work account in the Android Setup Wizard. Revokes any previously generated token.
93
94Args:
95 enterpriseId: string, The ID of the enterprise. (required)
96 userId: string, The ID of the user. (required)
97
98Returns:
99 An object of the form:
100
101 { # A UserToken is used by a user when setting up a managed device or profile with their work account on a device. When the user enters their email address and token (activation code) the appropriate MDM app can be automatically downloaded.
102 "kind": "androidenterprise#userToken", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#userToken".
103 "userId": "A String", # The unique ID for the user.
104 "token": "A String", # The token (activation code) to be entered by the user. This consists of a sequence of decimal digits. Note that the leading digit may be 0.
105 }</pre>
106</div>
107
108<div class="method">
109 <code class="details" id="get">get(enterpriseId, userId)</code>
110 <pre>Retrieves a user's details.
111
112Args:
113 enterpriseId: string, The ID of the enterprise. (required)
114 userId: string, The ID of the user. (required)
115
116Returns:
117 An object of the form:
118
119 { # A user resource represents an individual user within the enterprise's domain.
120 #
121 # Note that each user is associated with a Google account based on the user's corporate email address (which must be in one of the enterprise's domains). As part of installing an MDM app to manage a device the Google account must be provisioned to the device, and so the user resource must be created before that. This can be done using the Google Admin SDK Directory API.
122 #
123 # The ID for a user is an opaque string. It can be retrieved using the list method queried by the user's primary email address.
124 "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
125 "primaryEmail": "A String", # The user's primary email, e.g. "jsmith@example.com".
126 "id": "A String", # The unique ID for the user.
127 }</pre>
128</div>
129
130<div class="method">
131 <code class="details" id="list">list(enterpriseId, email)</code>
132 <pre>Looks up a user by email address.
133
134Args:
135 enterpriseId: string, The ID of the enterprise. (required)
136 email: string, The exact primary email address of the user to look up. (required)
137
138Returns:
139 An object of the form:
140
141 { # The matching user resources.
142 "kind": "androidenterprise#usersListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#usersListResponse".
143 "user": [ # A user of an enterprise.
144 { # A user resource represents an individual user within the enterprise's domain.
145 #
146 # Note that each user is associated with a Google account based on the user's corporate email address (which must be in one of the enterprise's domains). As part of installing an MDM app to manage a device the Google account must be provisioned to the device, and so the user resource must be created before that. This can be done using the Google Admin SDK Directory API.
147 #
148 # The ID for a user is an opaque string. It can be retrieved using the list method queried by the user's primary email address.
149 "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
150 "primaryEmail": "A String", # The user's primary email, e.g. "jsmith@example.com".
151 "id": "A String", # The unique ID for the user.
152 },
153 ],
154 }</pre>
155</div>
156
157<div class="method">
158 <code class="details" id="revokeToken">revokeToken(enterpriseId, userId)</code>
159 <pre>Revokes a previously generated token (activation code) for the user.
160
161Args:
162 enterpriseId: string, The ID of the enterprise. (required)
163 userId: string, The ID of the user. (required)
164</pre>
165</div>
166
167</body></html>