PUT api/v1/users/{userId}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
userId | globally unique identifier |
Required |
Body Parameters
UserDetailsName | Description | Type | Additional information |
---|---|---|---|
UserId | globally unique identifier |
None. |
|
ClubId | globally unique identifier |
Required |
|
FriendlyName | string |
Required String length: inclusive between 0 and 100 |
|
NotificationEmail | string |
Required String length: inclusive between 0 and 256 |
|
PersonId | globally unique identifier |
None. |
|
Remarks | string |
None. |
|
UserName | string |
Required String length: inclusive between 0 and 256 |
|
UserRoleIds | Collection of globally unique identifier |
None. |
|
AccountState | integer |
None. |
|
LastPasswordChangeOn | date |
None. |
|
ForcePasswordChangeNextLogon | boolean |
None. |
|
EmailConfirmed | boolean |
None. |
|
LanguageId | integer |
None. |
|
Id | globally unique identifier |
None. |
|
CanUpdateRecord | boolean |
None. |
|
CanDeleteRecord | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{ "UserId": "d49d223d-da3d-46fc-a611-b5c09beaa491", "ClubId": "c5cbc9c1-97cd-4d39-b95c-6073e2086480", "FriendlyName": "sample string 3", "NotificationEmail": "sample string 4", "PersonId": "da3a2027-25f2-438a-97a0-9e39529ddec3", "Remarks": "sample string 5", "UserName": "sample string 6", "UserRoleIds": [ "954a3ea3-29b7-49dd-a0f1-7cdde854b1e7", "fbcb8b36-663f-45ca-abc4-9e9718c0e575" ], "AccountState": 7, "LastPasswordChangeOn": "2024-10-29T15:42:44.4488701+01:00", "ForcePasswordChangeNextLogon": true, "EmailConfirmed": true, "LanguageId": 10, "Id": "d49d223d-da3d-46fc-a611-b5c09beaa491", "CanUpdateRecord": true, "CanDeleteRecord": true }
text/html
Sample:
{"UserId":"d49d223d-da3d-46fc-a611-b5c09beaa491","ClubId":"c5cbc9c1-97cd-4d39-b95c-6073e2086480","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"da3a2027-25f2-438a-97a0-9e39529ddec3","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["954a3ea3-29b7-49dd-a0f1-7cdde854b1e7","fbcb8b36-663f-45ca-abc4-9e9718c0e575"],"AccountState":7,"LastPasswordChangeOn":"2024-10-29T15:42:44.4488701+01:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"d49d223d-da3d-46fc-a611-b5c09beaa491","CanUpdateRecord":true,"CanDeleteRecord":true}
application/xml, text/xml
Sample:
<UserDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi.User"> <CanDeleteRecord xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi">true</CanDeleteRecord> <CanUpdateRecord xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi">true</CanUpdateRecord> <Id xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi">d49d223d-da3d-46fc-a611-b5c09beaa491</Id> <AccountState>7</AccountState> <ClubId>c5cbc9c1-97cd-4d39-b95c-6073e2086480</ClubId> <EmailConfirmed>true</EmailConfirmed> <ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon> <FriendlyName>sample string 3</FriendlyName> <LanguageId>10</LanguageId> <LastPasswordChangeOn>2024-10-29T15:42:44.4488701+01:00</LastPasswordChangeOn> <NotificationEmail>sample string 4</NotificationEmail> <PersonId>da3a2027-25f2-438a-97a0-9e39529ddec3</PersonId> <Remarks>sample string 5</Remarks> <UserId>d49d223d-da3d-46fc-a611-b5c09beaa491</UserId> <UserName>sample string 6</UserName> <UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>954a3ea3-29b7-49dd-a0f1-7cdde854b1e7</d2p1:guid> <d2p1:guid>fbcb8b36-663f-45ca-abc4-9e9718c0e575</d2p1:guid> </UserRoleIds> </UserDetails>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
UserDetailsName | Description | Type | Additional information |
---|---|---|---|
UserId | globally unique identifier |
None. |
|
ClubId | globally unique identifier |
Required |
|
FriendlyName | string |
Required String length: inclusive between 0 and 100 |
|
NotificationEmail | string |
Required String length: inclusive between 0 and 256 |
|
PersonId | globally unique identifier |
None. |
|
Remarks | string |
None. |
|
UserName | string |
Required String length: inclusive between 0 and 256 |
|
UserRoleIds | Collection of globally unique identifier |
None. |
|
AccountState | integer |
None. |
|
LastPasswordChangeOn | date |
None. |
|
ForcePasswordChangeNextLogon | boolean |
None. |
|
EmailConfirmed | boolean |
None. |
|
LanguageId | integer |
None. |
|
Id | globally unique identifier |
None. |
|
CanUpdateRecord | boolean |
None. |
|
CanDeleteRecord | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{ "UserId": "4ad895e6-2056-407b-b2ca-307e15075662", "ClubId": "53e8a29d-d519-464e-80f6-0acca26dae93", "FriendlyName": "sample string 3", "NotificationEmail": "sample string 4", "PersonId": "ccb0325b-6825-4e88-9987-d937ea85be4e", "Remarks": "sample string 5", "UserName": "sample string 6", "UserRoleIds": [ "7dded961-bf92-484d-bd47-f291658063a3", "221256cd-e9fd-4e3d-9a19-2842ac528137" ], "AccountState": 7, "LastPasswordChangeOn": "2024-10-29T15:42:44.4488701+01:00", "ForcePasswordChangeNextLogon": true, "EmailConfirmed": true, "LanguageId": 10, "Id": "4ad895e6-2056-407b-b2ca-307e15075662", "CanUpdateRecord": true, "CanDeleteRecord": true }
text/html
Sample:
{"UserId":"4ad895e6-2056-407b-b2ca-307e15075662","ClubId":"53e8a29d-d519-464e-80f6-0acca26dae93","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"ccb0325b-6825-4e88-9987-d937ea85be4e","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["7dded961-bf92-484d-bd47-f291658063a3","221256cd-e9fd-4e3d-9a19-2842ac528137"],"AccountState":7,"LastPasswordChangeOn":"2024-10-29T15:42:44.4488701+01:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"4ad895e6-2056-407b-b2ca-307e15075662","CanUpdateRecord":true,"CanDeleteRecord":true}
application/xml, text/xml
Sample:
<UserDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi.User"> <CanDeleteRecord xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi">true</CanDeleteRecord> <CanUpdateRecord xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi">true</CanUpdateRecord> <Id xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi">4ad895e6-2056-407b-b2ca-307e15075662</Id> <AccountState>7</AccountState> <ClubId>53e8a29d-d519-464e-80f6-0acca26dae93</ClubId> <EmailConfirmed>true</EmailConfirmed> <ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon> <FriendlyName>sample string 3</FriendlyName> <LanguageId>10</LanguageId> <LastPasswordChangeOn>2024-10-29T15:42:44.4488701+01:00</LastPasswordChangeOn> <NotificationEmail>sample string 4</NotificationEmail> <PersonId>ccb0325b-6825-4e88-9987-d937ea85be4e</PersonId> <Remarks>sample string 5</Remarks> <UserId>4ad895e6-2056-407b-b2ca-307e15075662</UserId> <UserName>sample string 6</UserName> <UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>7dded961-bf92-484d-bd47-f291658063a3</d2p1:guid> <d2p1:guid>221256cd-e9fd-4e3d-9a19-2842ac528137</d2p1:guid> </UserRoleIds> </UserDetails>