Systemusers

Update a system user

This endpoint allows you to update a system user.

Sample Request

curl -X PUT https://console.jumpcloud.com/api/systemusers/{UserID} \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -d '{
	"email":"{email_address}",
	"firstname":"{Name}",
	"lastname":"{Name}"
}'
put/systemusers/{id}

Request

Query parameters

fullValidationDetailsstring

This endpoint can take in a query when a client wants all validation errors to be returned with error response for the form field specified, i.e. 'password'

Password validation flag

Use the "password" validation flag to receive details on a possible bad request response Without the password flag, default behavior will be a normal 400 with only a validation string message

?fullValidationDetails=password

Expected Behavior

Clients can expect a list of validation error mappings for the validation query field in the details provided on the response:

{
  "code": 400,
  "message": "Password validation fail",
  "status": "INVALID_ARGUMENT",
  "details": [
      {
        "fieldViolationsList": [{ "field": "password", "description": "passwordHistory" }],
        '@type': 'type.googleapis.com/google.rpc.BadRequest',
      },
  ],
},

Headers

x-org-idstring

Request body

account_lockedboolean
allow_public_keyboolean
alternateEmailstring
companystring
costCenterstring
departmentstring
descriptionstring
disableDeviceMaxLoginAttemptsboolean
displaynamestring
emailstring
employeeIdentifierstring

Must be unique per user.

employeeTypestring
enable_managed_uidboolean
enable_user_portal_multifactorboolean
external_dnstring
external_password_expiration_datestring
external_source_typestring
externally_managedboolean

The externally_managed property has been deprecated. Whenever a user has their externally_managed field modified their restrictedFields property gets populated with the appropriate value, even if it is already set to a value an administrator manually set.

firstnamestring
jobTitlestring
lastnamestring
ldap_binding_userboolean
locationstring
managerstring

Relation with another systemuser to identify the last as a manager.

middlenamestring
passwordstring
password_never_expiresboolean
public_keystring
samba_service_userboolean
state'ACTIVATED' | 'SUSPENDED'
sudoboolean
suspendedboolean
tagsstring[]
unix_guidinteger
unix_uidinteger
usernamestring
managedAppleIdstring

Response

OK

_idstring
account_lockedboolean
account_locked_datestring nullable
activatedboolean
allow_public_keyboolean
alternateEmailstring
badLoginAttemptsinteger
companystring
costCenterstring
createdstring
departmentstring
descriptionstring
disableDeviceMaxLoginAttemptsboolean
displaynamestring
emailstring
employeeIdentifierstring

Must be unique per user.

employeeTypestring
enable_managed_uidboolean
enable_user_portal_multifactorboolean
external_dnstring
external_password_expiration_datestring
external_source_typestring
externally_managedboolean

The externally_managed property has been deprecated. Whenever a user has their externally_managed field modified their restrictedFields property gets populated with the appropriate value, even if it is already set to a value an administrator manually set.

firstnamestring
jobTitlestring
lastnamestring
ldap_binding_userboolean
locationstring
managerstring

Relation with another systemuser to identify the last as a manager.

middlenamestring
organizationstring
password_datestring nullable
password_expiration_datestring nullable
password_expiredboolean
password_never_expiresboolean
passwordless_sudoboolean
public_keystring
samba_service_userboolean
state'STAGED' | 'ACTIVATED' | 'SUSPENDED'
sudoboolean
suspendedboolean
tagsstring[]
totp_enabledboolean
unix_guidinteger
unix_uidinteger
usernamestring
managedAppleIdstring
creationSourcestring

Changes

No recorded changes to this operation across all 1 revision of this API.