Patch
|
|||||
|
|
||||
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
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- Manage corporate Android devices
Input
This building block consumes 9 input parameters
| Name | Format | Description |
|---|---|---|
enterpriseId Required |
STRING |
The ID of the enterprise |
userId Required |
STRING |
The ID of the user |
accountIdentifier |
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 |
accountType |
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 |
displayName |
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 |
id |
STRING |
The unique ID for the user |
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user" |
managementType |
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 |
STRING |
The user's primary email address, for example, "[email protected]". Will always be set for Google managed users and not set for EMM managed users |
= Parameter name
= Format
|
enterpriseId STRING Required The ID of the enterprise |
|
userId STRING Required The ID of the user |
|
accountIdentifier 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 |
|
accountType 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 |
|
displayName 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 |
|
id STRING The unique ID for the user |
|
kind STRING Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user" |
|
managementType 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 STRING The user's primary email address, for example, "[email protected]". Will always be set for Google managed users and not set for EMM managed users |
Output
This building block provides 7 output parameters
| Name | Format | Description |
|---|---|---|
accountIdentifier |
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 |
accountType |
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 |
displayName |
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 |
id |
STRING |
The unique ID for the user |
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user" |
managementType |
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 |
STRING |
The user's primary email address, for example, "[email protected]". Will always be set for Google managed users and not set for EMM managed users |
= Parameter name
= Format
|
accountIdentifier 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 |
|
accountType 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 |
|
displayName 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 |
|
id STRING The unique ID for the user |
|
kind STRING Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user" |
|
managementType 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 STRING The user's primary email address, for example, "[email protected]". Will always be set for Google managed users and not set for EMM managed users |