Update User

put

https://api.authcx.com/User/{UserId}

Updates information about an existing user in your organization.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

UserId

string

required

The string ID of the user to update

Body Params

firstName

string | null

The first name of the new user you intend to add.

lastName

string | null

The last name of the new user you intend to add.

userName

string | null

The username that the user signs in with (typically their email).

string | null

The email address of the new user you intend to add.

phoneNumber

string | null

The phone number you wish to assign to the user.

roleName

string | null

Must exactly match a role name from GET /Roles/All.

disabled

boolean | null

Set to true to disable the user's access.

samlProviderUserCode

string | null

Your SSO provider's identifier for this user, if applicable.

emailConfirmed

boolean | null

When specified to true, allows the user to skip confirming their email address.

enableAgentUser

boolean | null

Set to true to simultaneously create a matching, linked agent-user.

agentManagerId

string | null

The user ID to assign as the linked agent-user's manager. Pass "remove" to clear it.

hierarchyCodes

array of strings | null

Hierarchy codes the user should be assigned to, when hierarchy management by code is enabled for
your integration. A bare code grants View; append ":Edit" or ":Manage" for those levels. Omit to keep
the current assignments; send an empty list to remove them all. The list replaces every assignment
the user has, including ones made in the platform.

hierarchyCodes

hierarchyIds

array of strings | null

Hierarchy ids the user should be assigned to, when hierarchy management by id is enabled for your
integration. Same format and rules as hierarchyCodes.

hierarchyIds

Responses

400

200Returns the newly updated user