Updates a user resource. The following User properties are updatable: Custom01 Custom02 Custom03 Custom04 Custom05 Description Disabled EmailAddress PrimaryPhone UserName All of the above properties will be updated IF they are set in UserRepresentation. If not set, the property values will come through as null and will therefore not be set. To "blank" out the value set the property value to an empty string. Note: Updating User Role and Memebership data is not currently supported through the Web API.
Name | Description | Additional information |
---|---|---|
userId |
Define this parameter in the request URI. |
|
userRepresentation |
Define this parameter in the request body. |
{ "userId": "78faed81-c1b4-43d8-ad58-a04adee319f2", "tenantId": "35c41ea6-8611-4d44-9c07-d5fea1f1c480", "userGroupId": "81e6bcfa-c536-46f8-b8e2-aba96b9bbad8", "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": "2024-08-29T06:36:04.7756837+00:00", "updatedDateUtc": "2024-08-29T06:36:04.7756837+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>2024-08-29T06:36:04.7756837+00:00</CreatedDateUtc> <UpdatedDateUtc>2024-08-29T06:36:04.7756837+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>35c41ea6-8611-4d44-9c07-d5fea1f1c480</TenantId> <UserGroupId>81e6bcfa-c536-46f8-b8e2-aba96b9bbad8</UserGroupId> <UserId>78faed81-c1b4-43d8-ad58-a04adee319f2</UserId> <UserName>sample string 4</UserName> </UserRepresentation>
Sample not available.