Create a user

post

https://rls.congacloud.com/api/user-management/v1/users

Creates a new user and returns the user's ID.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

User model data to be created

FirstName

string | null

The user's first name

LastName

string | null

The user's last name

string | null

The user's email address

UserName

string | null

The user's unique username

Timezone

string | null

The user's time zone ID. For example: UTC

Note: To see a list of supported time zones, use the Timezone and Locale APIs.

Locale

string | null

The user's locale name. For example: en-US

Note: To see a list of supported locales, use the Timezone and Locale APIs.

Currency

string | null

The user's currency. For example: USD.

Note: To see a list of currencies, use the Currency API.

ExternalId

string | null

The user's unique record identifier from the external system

Alias

string | null

The user's alias name

Language

string | null

The user's language. For example: en-IN

Address

string | null

The user's postal address. This parameter is raw text with no structure or sub-fields. For example: 13699 Via Varra, Broomfield, CO 80020 United States

PhoneNumber

string | null

The user's phone number

Role

object

UserType

string

enum

Allowed:

OrganizationExternalId

string | null

The user's Organization External Id

CustomProperties

object | null

User object specific custom field(s) For example: You want to add two custom fields (CustomField1_c and BooleanField_c) on the User object. See the payload example below for reference. {"CustomProperties": {"CustomField1_c": "12334", "BooleanField_c": "true"}

FederationId

string | null

A unique identifier used to identify user in federated authentication systems

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error

201Created