Skip to main content
PATCH
Update a user

Authorizations

Authorization
string
header
required

A machine-client token from POST /v1/auth/client-token. Reads need the pulse.read scope; provisioning and tenant updates need pulse.write, which the token only carries when requested_scopes asks for it. Creating, changing, disabling and resetting MFA for users, and the tenant sign-in policy, need a signed-in user's token instead: they reject API-key tokens.

Path Parameters

userId
string<uuid>
required

The user: a user_id from List users (GET /v1/msp/admin/users).

Body

application/json

Send only the fields you want to change; omitted or null fields keep their current value. The change applies to the user's first access grant (the one Get a user returns).

tenant_id
null | string<uuid>

Moves the user's access to this tenant. Both the current and the new tenant must be your own tenant or beneath it.

first_name
null | string

The user's first name.

last_name
null | string

The user's last name. An empty string removes it.

email
null | string

The user's new email, which is also their login id. Changing it removes the user's email MFA method. An email already used by another user returns 409 email_taken.

password
null | string

Sets a new password, with the same rules as when the user was created. Too weak returns 400 password_rejected.

role
null | string

The user's new role: a key from List assignable user roles (GET /v1/msp/admin/user-roles).

enabled
null | boolean

false disables the user so they can no longer sign in; true lets a disabled user sign in again. Disabling or demoting a tenant's last administrator returns 409 last_admin_required.

Response

OK

A user and their access to one tenant.

user_id
string<uuid>
required

The user's id. Use it as userId in the other user endpoints.

first_name
string
required

The user's first name.

last_name
string
required

The user's last name. An empty string when none is set.

display_name
string
required

The user's full name, or their email when no name is set.

email
string
required

The user's email, which is also their login id.

tenant_id
string<uuid>
required

The tenant this access applies to (including the tenants beneath it).

tenant_name
string
required

The name of tenant_id.

roles
string[]
required

The user's role on this tenant: a key from List assignable user roles.

scopes
string[]
required

What the role allows: pulse.login, pulse.read, and pulse.write for admin roles.

status
string
required

active when the user can sign in; disabled when they have been disabled or are locked out.

last_login_at
null | string<date-time>
required

When the user last signed in: an ISO 8601 timestamp in UTC (offset +00:00). Null if they never have.

selected_mfa_method
null | enum<string>
required

The MFA method the user chose: email or totp. Null when none is chosen.

Available options:
email,
totp
enrolled_mfa_methods
enum<string>[]
required

The MFA methods the user has set up: email, totp, both, or none.

Available options:
email,
totp