Creates a new User.
| Name | Description | Additional information |
|---|---|---|
| userRepresentation | - The TenantId field is required, and should match the tenant on the HTTP request header.
- The UserId field should not be specified by the caller, this will be set by the server, and returned in the response.
- The UserGroupId is optional, and if it is not specified, it will be set to the default UserGroup for the Tenant.
- The UserName is required, and must be unique within the specified Tenant.
- The Password is required, and should be in plain-text. This will be hashed for storage in the database.
- The Role is optional, and if not specified, it will be set to the default role for the tenant (usually "TenantUser")
- The EmailAddress field is optional.
- The PrimaryPhone field is optional.
- The Custom01 - Custom05 fields are optional. |
Define this parameter in the request body. |
{
"userId": "4e18762f-c4a3-494f-87a7-acdbfb10639e",
"tenantId": "2eb640c1-99ec-40fb-b040-20890fdc10f2",
"userGroupId": "33609a45-dee8-49f3-b822-3fcbc03def9c",
"membershipUserId": 3,
"userName": "sample string 4",
"description": "sample string 5",
"roles": [
"sample string 1",
"sample string 2",
"sample string 3"
],
"password": "sample string 6",
"disabled": true,
"emailAddress": "sample string 8",
"primaryPhone": "sample string 9",
"custom01": "sample string 10",
"custom02": "sample string 11",
"custom03": "sample string 12",
"custom04": "sample string 13",
"custom05": "sample string 14",
"createdDateUtc": "2025-04-21T01:10:47.7979675+00:00",
"updatedDateUtc": "2025-04-21T01:10:47.7979675+00:00"
}
<UserRepresentation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BlueDot.Cyan.Server.Core.Models.Rest.Version1">
<CreatedDateUtc>2025-04-21T01:10:47.7979675+00:00</CreatedDateUtc>
<UpdatedDateUtc>2025-04-21T01:10:47.7979675+00:00</UpdatedDateUtc>
<Custom01>sample string 10</Custom01>
<Custom02>sample string 11</Custom02>
<Custom03>sample string 12</Custom03>
<Custom04>sample string 13</Custom04>
<Custom05>sample string 14</Custom05>
<Description>sample string 5</Description>
<Disabled>true</Disabled>
<EmailAddress>sample string 8</EmailAddress>
<MembershipUserId>3</MembershipUserId>
<Password>sample string 6</Password>
<PrimaryPhone>sample string 9</PrimaryPhone>
<Roles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
<d2p1:string>sample string 3</d2p1:string>
</Roles>
<TenantId>2eb640c1-99ec-40fb-b040-20890fdc10f2</TenantId>
<UserGroupId>33609a45-dee8-49f3-b822-3fcbc03def9c</UserGroupId>
<UserId>4e18762f-c4a3-494f-87a7-acdbfb10639e</UserId>
<UserName>sample string 4</UserName>
</UserRepresentation>
Sample not available.