This method can be used by a qualified admin (SUPER_USER or MANAGE_USERS adminRoles) to update user data.

Most users have a single GetGo account, but if the user has multiple GetGo accounts, there are limitations to your ability to make updates. Modification of core user identity (firstName, lastName, email, and locale) can only be done in the user's primary account, and only by a qualified admin in that primary account. A primary account is the user's first GetGo collaboration product account. A secondary account is one created for users who are accessing GetGo collaboration products through two different organizations (e.g., consultants, developers, freelance trainers, etc.). If a user's core identity in a secondary account must be modified, contact the Customer Service Representative for that account.

All qualified admins can update a user's admin status, adminRoles and managedGroupKeys. Qualified admin users will have the field identityReadOnly = false in the Get User response. You can view users' accounts in the Get User or Get All Users responses. Users have a single organizerKey across all accounts.

NOTE: You cannot create a user with an admin or manager role if that user has hasAdminAccess set to false. This is generally an internal-only setting and should not impact outside developers.

Admin roles are defined in Implementation.  All values must be valid and the user initiating the call must have adequate permissions to make this call.

See Manage Users for additional group methods.

Roles

SUPER_USER
MANAGE_USERS

URL

https://api.getgo.com/admin/rest/v1/accounts/{accountKey}/users/{userKey}

Method

PUT

Response Type

JSON

HTTP Request Example

PUT
https://api.getgo.com/admin/rest/v1/accounts/8830995/users/123
HTTP 1.1
Accept: application/json
Content-type: application/json
Authorization: OAuth oauth_token= ZlUe11FakEyCWxtOkeN3wk0uTKuL {
 "email":"Juvene.Loral@realwhirled.org",
 "firstName":"Juvene",
 "lastName":"Loral",
 "admin":true,
 "locale":"en_US"
 "adminRoles":["MANAGE_USERS","MANAGE_SEATS"],
 "managedGroupKeys":["555,"777"],
}

Response Example

204 No Content

Status Codes

Status Code Field/Rejected Value Description
400 Bad Request user.email.required email User email cannot be empty if provided
400 Bad Request user.email.maxlength email User email exceeds 128 characters
400 Bad Request user.email.invalid email User email is invalid
400 Bad Request user.firstname.required firstName User first name cannot be empty if provided
400 Bad Request user.firstname.maxlength firstName User first name exceeds 32 characters
400 Bad Request user.firstname.invalid firstName User first name is invalid
400 Bad Request user.lastname.required lastName User last name cannot be empty if provided
400 Bad Request user.lastname.maxlength lastName User last name exceeds 32 characters
400 Bad Request user.lastname.invalid lastName User last name is invalid
400 Bad Request user.locale.invalid locale User locale is invalid
400 Bad Request user.managedgroupkeys.nonulls managedGroupKeys Group keys array contains null
404 Not Found user.not.found User does not exist
404 Not Found group.not.found Group does not exist
404 Not Found user.not.found User does not exist
404 Not Found group.not.found Group does not exist
422 Unprocessable Entity user.admin.caller User is the admin caller
422 Unprocessable Entity user.manager.caller managedGroupKeys Manager is not permitted to update roles or managed groups
422 Unprocessable Entity identity.read.only   Manager is not permitted to update key user data