Update documentation
diff --git a/docs/dyn/androidenterprise_v1.users.html b/docs/dyn/androidenterprise_v1.users.html
index 45fafda..493ee4d 100644
--- a/docs/dyn/androidenterprise_v1.users.html
+++ b/docs/dyn/androidenterprise_v1.users.html
@@ -75,6 +75,12 @@
<h1><a href="androidenterprise_v1.html">Google Play EMM API</a> . <a href="androidenterprise_v1.users.html">users</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
+ <code><a href="#delete">delete(enterpriseId, userId)</a></code></p>
+<p class="firstline">Deleted an EMM-managed user.</p>
+<p class="toc_element">
+ <code><a href="#generateAuthenticationToken">generateAuthenticationToken(enterpriseId, userId)</a></code></p>
+<p class="firstline">Generates an authentication token which the device policy client can use to provision the given EMM-managed user account on a device. The generated token is single-use and expires after a few minutes.</p>
+<p class="toc_element">
<code><a href="#generateToken">generateToken(enterpriseId, userId)</a></code></p>
<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>
<p class="toc_element">
@@ -84,16 +90,54 @@
<code><a href="#getAvailableProductSet">getAvailableProductSet(enterpriseId, userId)</a></code></p>
<p class="firstline">Retrieves the set of products a user is entitled to access.</p>
<p class="toc_element">
+ <code><a href="#insert">insert(enterpriseId, body)</a></code></p>
+<p class="firstline">Creates a new EMM-managed user.</p>
+<p class="toc_element">
<code><a href="#list">list(enterpriseId, email)</a></code></p>
-<p class="firstline">Looks up a user by their primary email address.</p>
+<p class="firstline">Looks up a user by primary email address. This is only supported for Google-managed users. Lookup of the id is not needed for EMM-managed users because the id is already returned in the result of the Users.insert call.</p>
+<p class="toc_element">
+ <code><a href="#patch">patch(enterpriseId, userId, body)</a></code></p>
+<p class="firstline">Updates the details of an EMM-managed user.</p>
<p class="toc_element">
<code><a href="#revokeToken">revokeToken(enterpriseId, userId)</a></code></p>
<p class="firstline">Revokes a previously generated token (activation code) for the user.</p>
<p class="toc_element">
<code><a href="#setAvailableProductSet">setAvailableProductSet(enterpriseId, userId, body)</a></code></p>
<p class="firstline">Modifies the set of products a user is entitled to access.</p>
+<p class="toc_element">
+ <code><a href="#update">update(enterpriseId, userId, body)</a></code></p>
+<p class="firstline">Updates the details of an EMM-managed user.</p>
<h3>Method Details</h3>
<div class="method">
+ <code class="details" id="delete">delete(enterpriseId, userId)</code>
+ <pre>Deleted an EMM-managed user.
+
+Args:
+ enterpriseId: string, The ID of the enterprise. (required)
+ userId: string, The ID of the user. (required)
+</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="generateAuthenticationToken">generateAuthenticationToken(enterpriseId, userId)</code>
+ <pre>Generates an authentication token which the device policy client can use to provision the given EMM-managed user account on a device. The generated token is single-use and expires after a few minutes.
+
+This call only works with EMM-managed accounts.
+
+Args:
+ enterpriseId: string, The ID of the enterprise. (required)
+ userId: string, The ID of the user. (required)
+
+Returns:
+ An object of the form:
+
+ { # An AuthenticationToken is used by the EMM's device policy client on a device to provision the given EMM-managed user on that device.
+ "kind": "androidenterprise#authenticationToken", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#authenticationToken".
+ "token": "A String", # The authentication token to be passed to the device policy client on the device where it can be used to provision the account for which this token was generated.
+ }</pre>
+</div>
+
+<div class="method">
<code class="details" id="generateToken">generateToken(enterpriseId, userId)</code>
<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.
@@ -124,13 +168,15 @@
Returns:
An object of the form:
- { # A user resource represents an individual user within the enterprise's domain.
- #
- # 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 the EMM's DPC 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.
- #
- # 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.
+ { # A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to Google Play for Work only, or to other Google services, depending on the identity model:
+ # - Google managed domain identity model requires synchronization to Google account sources (via primaryEmail).
+ # - Android for Work Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to Google Play for Work only.
"kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
- "primaryEmail": "A String", # The user's primary email, e.g. "jsmith@example.com".
+ "displayName": "A String", # The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as "Example, Inc.") or your name (as EMM). Not used for Google-managed user accounts.
+ "accountIdentifier": "A String", # A unique identifier you create for this user, such as "user342" or "asset#44418". Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users.
+ "managementType": "A String", # The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge.
+ "primaryEmail": "A String", # The user's primary email address, for example, "jsmith@example.com". Will always be set for Google managed users and not set for EMM managed users.
+ "accountType": "A String", # The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount.
"id": "A String", # The unique ID for the user.
}</pre>
</div>
@@ -155,8 +201,48 @@
</div>
<div class="method">
+ <code class="details" id="insert">insert(enterpriseId, body)</code>
+ <pre>Creates a new EMM-managed user.
+
+The Users resource passed in the body of the request should include an accountIdentifier and an accountType.
+
+Args:
+ enterpriseId: string, The ID of the enterprise. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to Google Play for Work only, or to other Google services, depending on the identity model:
+ # - Google managed domain identity model requires synchronization to Google account sources (via primaryEmail).
+ # - Android for Work Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to Google Play for Work only.
+ "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
+ "displayName": "A String", # The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as "Example, Inc.") or your name (as EMM). Not used for Google-managed user accounts.
+ "accountIdentifier": "A String", # A unique identifier you create for this user, such as "user342" or "asset#44418". Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users.
+ "managementType": "A String", # The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge.
+ "primaryEmail": "A String", # The user's primary email address, for example, "jsmith@example.com". Will always be set for Google managed users and not set for EMM managed users.
+ "accountType": "A String", # The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount.
+ "id": "A String", # The unique ID for the user.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to Google Play for Work only, or to other Google services, depending on the identity model:
+ # - Google managed domain identity model requires synchronization to Google account sources (via primaryEmail).
+ # - Android for Work Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to Google Play for Work only.
+ "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
+ "displayName": "A String", # The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as "Example, Inc.") or your name (as EMM). Not used for Google-managed user accounts.
+ "accountIdentifier": "A String", # A unique identifier you create for this user, such as "user342" or "asset#44418". Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users.
+ "managementType": "A String", # The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge.
+ "primaryEmail": "A String", # The user's primary email address, for example, "jsmith@example.com". Will always be set for Google managed users and not set for EMM managed users.
+ "accountType": "A String", # The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount.
+ "id": "A String", # The unique ID for the user.
+ }</pre>
+</div>
+
+<div class="method">
<code class="details" id="list">list(enterpriseId, email)</code>
- <pre>Looks up a user by their primary email address.
+ <pre>Looks up a user by primary email address. This is only supported for Google-managed users. Lookup of the id is not needed for EMM-managed users because the id is already returned in the result of the Users.insert call.
Args:
enterpriseId: string, The ID of the enterprise. (required)
@@ -168,13 +254,15 @@
{ # The matching user resources.
"kind": "androidenterprise#usersListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#usersListResponse".
"user": [ # A user of an enterprise.
- { # A user resource represents an individual user within the enterprise's domain.
- #
- # 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 the EMM's DPC 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.
- #
- # 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.
+ { # A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to Google Play for Work only, or to other Google services, depending on the identity model:
+ # - Google managed domain identity model requires synchronization to Google account sources (via primaryEmail).
+ # - Android for Work Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to Google Play for Work only.
"kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
- "primaryEmail": "A String", # The user's primary email, e.g. "jsmith@example.com".
+ "displayName": "A String", # The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as "Example, Inc.") or your name (as EMM). Not used for Google-managed user accounts.
+ "accountIdentifier": "A String", # A unique identifier you create for this user, such as "user342" or "asset#44418". Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users.
+ "managementType": "A String", # The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge.
+ "primaryEmail": "A String", # The user's primary email address, for example, "jsmith@example.com". Will always be set for Google managed users and not set for EMM managed users.
+ "accountType": "A String", # The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount.
"id": "A String", # The unique ID for the user.
},
],
@@ -182,6 +270,47 @@
</div>
<div class="method">
+ <code class="details" id="patch">patch(enterpriseId, userId, body)</code>
+ <pre>Updates the details of an EMM-managed user.
+
+Can be used with EMM-managed users only (not Google managed users). Pass the new details in the Users resource in the request body. Only the displayName field can be changed. Other fields must either be unset or have the currently active value. This method supports patch semantics.
+
+Args:
+ enterpriseId: string, The ID of the enterprise. (required)
+ userId: string, The ID of the user. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to Google Play for Work only, or to other Google services, depending on the identity model:
+ # - Google managed domain identity model requires synchronization to Google account sources (via primaryEmail).
+ # - Android for Work Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to Google Play for Work only.
+ "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
+ "displayName": "A String", # The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as "Example, Inc.") or your name (as EMM). Not used for Google-managed user accounts.
+ "accountIdentifier": "A String", # A unique identifier you create for this user, such as "user342" or "asset#44418". Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users.
+ "managementType": "A String", # The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge.
+ "primaryEmail": "A String", # The user's primary email address, for example, "jsmith@example.com". Will always be set for Google managed users and not set for EMM managed users.
+ "accountType": "A String", # The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount.
+ "id": "A String", # The unique ID for the user.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to Google Play for Work only, or to other Google services, depending on the identity model:
+ # - Google managed domain identity model requires synchronization to Google account sources (via primaryEmail).
+ # - Android for Work Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to Google Play for Work only.
+ "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
+ "displayName": "A String", # The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as "Example, Inc.") or your name (as EMM). Not used for Google-managed user accounts.
+ "accountIdentifier": "A String", # A unique identifier you create for this user, such as "user342" or "asset#44418". Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users.
+ "managementType": "A String", # The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge.
+ "primaryEmail": "A String", # The user's primary email address, for example, "jsmith@example.com". Will always be set for Google managed users and not set for EMM managed users.
+ "accountType": "A String", # The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount.
+ "id": "A String", # The unique ID for the user.
+ }</pre>
+</div>
+
+<div class="method">
<code class="details" id="revokeToken">revokeToken(enterpriseId, userId)</code>
<pre>Revokes a previously generated token (activation code) for the user.
@@ -220,4 +349,45 @@
}</pre>
</div>
+<div class="method">
+ <code class="details" id="update">update(enterpriseId, userId, body)</code>
+ <pre>Updates the details of an EMM-managed user.
+
+Can be used with EMM-managed users only (not Google managed users). Pass the new details in the Users resource in the request body. Only the displayName field can be changed. Other fields must either be unset or have the currently active value.
+
+Args:
+ enterpriseId: string, The ID of the enterprise. (required)
+ userId: string, The ID of the user. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to Google Play for Work only, or to other Google services, depending on the identity model:
+ # - Google managed domain identity model requires synchronization to Google account sources (via primaryEmail).
+ # - Android for Work Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to Google Play for Work only.
+ "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
+ "displayName": "A String", # The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as "Example, Inc.") or your name (as EMM). Not used for Google-managed user accounts.
+ "accountIdentifier": "A String", # A unique identifier you create for this user, such as "user342" or "asset#44418". Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users.
+ "managementType": "A String", # The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge.
+ "primaryEmail": "A String", # The user's primary email address, for example, "jsmith@example.com". Will always be set for Google managed users and not set for EMM managed users.
+ "accountType": "A String", # The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount.
+ "id": "A String", # The unique ID for the user.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to Google Play for Work only, or to other Google services, depending on the identity model:
+ # - Google managed domain identity model requires synchronization to Google account sources (via primaryEmail).
+ # - Android for Work Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to Google Play for Work only.
+ "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
+ "displayName": "A String", # The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as "Example, Inc.") or your name (as EMM). Not used for Google-managed user accounts.
+ "accountIdentifier": "A String", # A unique identifier you create for this user, such as "user342" or "asset#44418". Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users.
+ "managementType": "A String", # The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge.
+ "primaryEmail": "A String", # The user's primary email address, for example, "jsmith@example.com". Will always be set for Google managed users and not set for EMM managed users.
+ "accountType": "A String", # The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount.
+ "id": "A String", # The unique ID for the user.
+ }</pre>
+</div>
+
</body></html>
\ No newline at end of file