Create User

post

https://api.authcx.com/User

Adds a user to your organization.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

firstName

string

required

length ≥ 1

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

lastName

string

required

length ≥ 1

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

userName

string

required

length ≥ 1

The username the new user will sign in with (typically their email).

string

required

length ≥ 1

Email address where the invitation will be sent.

phoneNumber

string | null

The phone number you wish to assign to the user.

roleName

string | null

Role to assign. Must exactly match a role name returned by GET /Roles/All.

samlProviderUserCode

string | null

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

emailConfirmed

boolean | null

Set to true to skip email confirmation for the new user.

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.

hierarchyCodes

array of strings | null

Hierarchy codes to assign the new user to, when hierarchy management by code is enabled for your
integration. A bare code grants View; append ":Edit" or ":Manage" for those levels.

hierarchyCodes

hierarchyIds

array of strings | null

Hierarchy ids to assign the new user to, when hierarchy management by id is enabled for your
integration. Same format as hierarchyCodes.

hierarchyIds

Responses

400

One or more of the required fields were incorrect or belonged to a user that already exists

200Returns the newly created user