Updates the user account.

put

https://{region}.api.jamfcloud.com/pro/v1/accounts/{id}

Updates the user account for the given id.

The requesting account cannot grant a privilege level, access level or site it does not
itself hold, and cannot change its own. Fields whose value is unchanged are not restricted,
so an account may be sent back in full to edit an unrelated field.

Required Permissions: accounts:update

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

id of target account

Body Params

plainPassword

password

username

string

realname

string

phone

string

ldapServerId

integer

Defaults to -1

distinguishedName

string

siteId

integer

Defaults to -1

Site the account is scoped to, or -1 for no site. Omitting this field on an update
applies the default of -1 and therefore clears any site already set, so send the
current value to keep it. Changing it requires the requesting account to have full
access.

accessLevel

string

enum

Defaults to FullAccess

Access level for the account. Omitting this field applies the default of FullAccess,
which the requesting account may only grant if it has full access itself.

Allowed:

privilegeLevel

string

enum

Defaults to ADMINISTRATOR

Privilege level for the account. Omitting this field applies the default of
ADMINISTRATOR; ADMINISTRATOR, AUDITOR and ENROLLMENT expand to fixed privilege sets
and may only be granted by an administrator.

Allowed:

changePasswordOnNextLogin

boolean

accountStatus

string

enum

Defaults to Enabled

Status of the account

Allowed:

accountType

string

enum

Defaults to DEFAULT

Type of the account

Allowed:

Headers

X-Tenant-Id

uuid

^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

The tenant UUID identifier. Send it to address tenant scope. This API is also published at environment scope — send that scope's header instead. Send exactly one scope header per request.

X-Environment-Id

uuid

^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

The environment UUID identifier. Send it to address environment scope. This API is also published at tenant scope — send that scope's header instead. Send exactly one scope header per request.

Responses

400

Bad Request - validation failure

403

Forbidden - the requesting account cannot grant the requested authority

404

Not Found - user account does not exist

Language

Credentials

OAuth2

URL

Loading…

Response

Choose an example:

application/json

200Successful response - Jamf Pro user account updated