Update a User

patch

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

This endpoint updates an existing User resource. It is not neccessary to include the complete replacement object in the API call; an object containing the properties that are to be changed will suffice.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

length ≤ 20

The unique identifier of the User to update.

Query Params

username

string

length ≤ 255

The unique Username used to login.

firstName

string

length ≤ 255

The user's first name.

lastName

string

length ≤ 255

The user's last name.

string

length ≤ 255

The user's email address.

phone

integer

The user's phone number. Must be a valid phone number.

partner

object

The partner under which the user should be created. Required for creating users that have the Partner-level roles.

client

object

The partner under which the user should be created. Required for creating users that have the Client-level roles.

isActive

boolean

The activation status of the user being created. Only active users are able to access ShieldConex.

sendWelcomeEmail

boolean

When this flag is set to true, the new user will recieve a welcome email upon successful creation of a user. It is recommended to set this to true only for active users.

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).

partner

object

Reference to the associated Partner. When used for POST and PATCH API calls, the reference can contain either the ID or Name. With GET API calls, both properties are populated.

client

object

Reference to the associated Client resource. When used for POST and PATCH API calls, the reference can contain either the ID or Name. With GET API calls, both properties are populated.

userRole

object

Reference to the associated User Role.

isActive

boolean

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.

sendWelcomeEmail

boolean

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

Responses

401

Unauthorized

403

Forbidden

404

Not found

200User update response

409Invalid data

500Internal server error