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": "1ba439b4-d66e-4649-b739-4fd37565037d", "ClubId": "141e2a35-fbec-4af4-a77b-42a9273daaf1", "FriendlyName": "sample string 3", "NotificationEmail": "sample string 4", "PersonId": "0c48d450-9802-4d32-ae0d-917363e87ca2", "Remarks": "sample string 5", "UserName": "sample string 6", "UserRoleIds": [ "e09a4eb4-3903-440d-9fec-9a123cf1649b", "6cf4318f-c23d-48ee-b9d6-1496878af161" ], "AccountState": 7, "LastPasswordChangeOn": "2024-05-16T19:59:19.7555055+02:00", "ForcePasswordChangeNextLogon": true, "EmailConfirmed": true, "LanguageId": 10, "Id": "1ba439b4-d66e-4649-b739-4fd37565037d", "CanUpdateRecord": true, "CanDeleteRecord": true }
text/html
Sample:
{"UserId":"1ba439b4-d66e-4649-b739-4fd37565037d","ClubId":"141e2a35-fbec-4af4-a77b-42a9273daaf1","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"0c48d450-9802-4d32-ae0d-917363e87ca2","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["e09a4eb4-3903-440d-9fec-9a123cf1649b","6cf4318f-c23d-48ee-b9d6-1496878af161"],"AccountState":7,"LastPasswordChangeOn":"2024-05-16T19:59:19.7555055+02:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"1ba439b4-d66e-4649-b739-4fd37565037d","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">1ba439b4-d66e-4649-b739-4fd37565037d</Id> <AccountState>7</AccountState> <ClubId>141e2a35-fbec-4af4-a77b-42a9273daaf1</ClubId> <EmailConfirmed>true</EmailConfirmed> <ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon> <FriendlyName>sample string 3</FriendlyName> <LanguageId>10</LanguageId> <LastPasswordChangeOn>2024-05-16T19:59:19.7555055+02:00</LastPasswordChangeOn> <NotificationEmail>sample string 4</NotificationEmail> <PersonId>0c48d450-9802-4d32-ae0d-917363e87ca2</PersonId> <Remarks>sample string 5</Remarks> <UserId>1ba439b4-d66e-4649-b739-4fd37565037d</UserId> <UserName>sample string 6</UserName> <UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>e09a4eb4-3903-440d-9fec-9a123cf1649b</d2p1:guid> <d2p1:guid>6cf4318f-c23d-48ee-b9d6-1496878af161</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": "4ab531e4-e74c-48ac-ae0f-f7d3dbc92f6c", "ClubId": "adea7465-e8f0-4cbd-a353-000644782058", "FriendlyName": "sample string 3", "NotificationEmail": "sample string 4", "PersonId": "aecbac21-29bd-435b-87e0-54a87554cece", "Remarks": "sample string 5", "UserName": "sample string 6", "UserRoleIds": [ "17a24f9a-4a19-4c62-8924-ce71919ba523", "940b883e-d838-454d-861c-dbdadb1be602" ], "AccountState": 7, "LastPasswordChangeOn": "2024-05-16T19:59:19.7555055+02:00", "ForcePasswordChangeNextLogon": true, "EmailConfirmed": true, "LanguageId": 10, "Id": "4ab531e4-e74c-48ac-ae0f-f7d3dbc92f6c", "CanUpdateRecord": true, "CanDeleteRecord": true }
text/html
Sample:
{"UserId":"4ab531e4-e74c-48ac-ae0f-f7d3dbc92f6c","ClubId":"adea7465-e8f0-4cbd-a353-000644782058","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"aecbac21-29bd-435b-87e0-54a87554cece","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["17a24f9a-4a19-4c62-8924-ce71919ba523","940b883e-d838-454d-861c-dbdadb1be602"],"AccountState":7,"LastPasswordChangeOn":"2024-05-16T19:59:19.7555055+02:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"4ab531e4-e74c-48ac-ae0f-f7d3dbc92f6c","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">4ab531e4-e74c-48ac-ae0f-f7d3dbc92f6c</Id> <AccountState>7</AccountState> <ClubId>adea7465-e8f0-4cbd-a353-000644782058</ClubId> <EmailConfirmed>true</EmailConfirmed> <ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon> <FriendlyName>sample string 3</FriendlyName> <LanguageId>10</LanguageId> <LastPasswordChangeOn>2024-05-16T19:59:19.7555055+02:00</LastPasswordChangeOn> <NotificationEmail>sample string 4</NotificationEmail> <PersonId>aecbac21-29bd-435b-87e0-54a87554cece</PersonId> <Remarks>sample string 5</Remarks> <UserId>4ab531e4-e74c-48ac-ae0f-f7d3dbc92f6c</UserId> <UserName>sample string 6</UserName> <UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>17a24f9a-4a19-4c62-8924-ce71919ba523</d2p1:guid> <d2p1:guid>940b883e-d838-454d-861c-dbdadb1be602</d2p1:guid> </UserRoleIds> </UserDetails>