API ReferenceAccessUsers

Update a user

Update a business user’s profile, roles, or direct permissions and synchronize the changes to the identity provider.

Required permissions: user:update.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

user_idstringRequired
The ID of the user.

Headers

X-Penny-As-Businessstring or nullOptional

Act on behalf of another business that has granted you access. Requires the business:act_as permission.

Request

This endpoint expects an object.
given_namestring or nullOptional1-150 characters
A replacement first name. Omit to leave it unchanged.
family_namestring or nullOptional1-150 characters
A replacement family name. Omit to leave it unchanged.
emailstring or nullOptionalformat: "email"

A replacement sign-in email address.

nicknamestring or nullOptional<=150 characters
A replacement display name. Set to null to remove it.
phonestring or nullOptional
A replacement E.164 phone number. Set to null to remove the phone number.
addressobject or nullOptional
A replacement postal address. Set to null to remove it.
role_idslist of strings or nullOptional
The complete replacement set of custom or preset role IDs. Send an empty set to remove all roles.
permissionslist of objects or nullOptional

The complete replacement set of permissions granted directly to the user. Send an empty set to remove all direct permissions. Every permission is scoped to your business; scope, sub-type, and resource-ID restrictions are not client-configurable.

Response

The updated user.
BusinessUserobject

A business user, as shown to clients through the client-facing API.

OR
CardholderUserobject

A cardholder user, as shown to clients through the client-facing API.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error