This endpoint updates an existing User resource.

patch

https://portal-cert.shieldconex.com:4010/api/v1/users/{id}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int64

required

≥ 1

The unique identifier of the User to update.

Body Params

User to be updated.

userName

string

length ≤ 255

The User's unique username.

firstName

string

length ≤ 255

The User's name.

lastName

string

length ≤ 255

The User's Surname.

string

length ≤ 255

The User's email address.

phone

string

length ≤ 255

The User's phone number without dashes, spaces, or brackets (e.g. +14155552671).

isActive

This property indicates if the User account is active or disabled. Once a user has logged into the system, their account cannot be deleted. As an alternative, their account can be set to inactive.

userRole

object

Reference to the associated User Role.

partner

PartnerReferenceMergePatchUpdateOrCreate | null

client

ClientReferenceMergePatchUpdateOrCreate | null

sendWelcomeEmail

If this property is set to 'true' the newly created user will be sent a welcome email.

version

int32

The number of times that this resource has been updated.

Responses

200The request has succeeded.

401Access is unauthorized.

403Access is forbidden.

404The server cannot find the requested resource.

409The request conflicts with the current state of the server.

429Too many requests.

500Server error