update_user
Update a user.
Input fields
String)
User address line 1. Maximum length is 255 characters.
String)
User address line 2. Maximum length is 255 characters.
String)
User city. Maximum length is 255 characters.
String)
User country code (ISO 3166-1). Maximum length is 4 characters.
String)
The email address for the user. Must be unique across all FieldAgent users. Maximum length is 255 characters.
String)
The first name of the user. Maximum length is 255 characters.
String)
The last name of the user. Maximum length is 255 characters.
ID!)
User Sentera ID (ready only).
String)
User state/province/region code (ISO 3166-2). Maximum length is 4 characters.
String)
User zip code. Maximum length is 255 characters.
Return fields
String)
User address line 1.
String)
User address line 2.
String)
User city.
String!)
User country code (ISO 3166-1).
String!)
The email address for the user.
Boolean!)
Has this user's employer opted into the enterprise license agreement.
String!)
The first name of the user.
String)
The last name of the user.
UserLicense!)
The type of license currently assigned to the user.
LogosQueryResult)
A list of logos for this user.
| Argument | Type | Description |
|---|---|---|
pagination |
Pagination!
|
Paginate the results. |
sentera_id |
ID
|
Retrieve the logo with the given Sentera ID. |
Organization!)
The organization this user belongs to.
JSON!)
Please use the organizations query instead to build the organization hierarchy.
A list of organization hierarchies comprised of the user's home organization and any organizations the user is partnered with, returned as a JSON array of hashes. Available keys in each hash are sentera_id (string), name (string) and children (array). This structure is recursive.
String)
The phone number for the user.
UserPreferences!)
The app preferences for this user.
[UserRole!]!)
An array of all of the user's roles.
ID!)
A system-generated key identifying a specific instance of a user.
SignaturesQueryResult)
A list of signatures for this user.
| Argument | Type | Description |
|---|---|---|
pagination |
Pagination!
|
Paginate the results. |
sentera_id |
ID
|
Retrieve the signature with the given Sentera ID. |
String)
User state/province/region code (ISO 3166-2).
UserStatus!)
The current status of the user.
String)
User zip code.
Examples
Update User
Updates a user. This mutation can only be run by a user with the client admin role, and can only be used on users in the current user's organization.
Try this example in GraphiQLmutation UpdateUser{
update_user(
sentera_id: "2idjv9o_US_bw1kAcmeOrg_CV_prod_9d89c370_190528_170322"
first_name: "Nancy"
) {
sentera_id
first_name
}
}
{
"data": {
"update_user": {
"first_name": "Nancy"
}
}
}