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": "ad36e72c-9d60-4412-bdb9-1bad467af347", "ClubId": "a6af1949-9b9f-4f4a-8d45-162bf986d1f0", "FriendlyName": "sample string 3", "NotificationEmail": "sample string 4", "PersonId": "69437d9a-1ccb-431f-abf2-b2af19b5827d", "Remarks": "sample string 5", "UserName": "sample string 6", "UserRoleIds": [ "e3617f6b-7f05-4b7b-9201-5b3374fad462", "4b82ae84-2697-49d8-bf3b-1386865ba33e" ], "AccountState": 7, "LastPasswordChangeOn": "2024-07-27T08:41:14.4140728+02:00", "ForcePasswordChangeNextLogon": true, "EmailConfirmed": true, "LanguageId": 10, "Id": "ad36e72c-9d60-4412-bdb9-1bad467af347", "CanUpdateRecord": true, "CanDeleteRecord": true }
text/html
Sample:
{"UserId":"ad36e72c-9d60-4412-bdb9-1bad467af347","ClubId":"a6af1949-9b9f-4f4a-8d45-162bf986d1f0","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"69437d9a-1ccb-431f-abf2-b2af19b5827d","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["e3617f6b-7f05-4b7b-9201-5b3374fad462","4b82ae84-2697-49d8-bf3b-1386865ba33e"],"AccountState":7,"LastPasswordChangeOn":"2024-07-27T08:41:14.4140728+02:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"ad36e72c-9d60-4412-bdb9-1bad467af347","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">ad36e72c-9d60-4412-bdb9-1bad467af347</Id> <AccountState>7</AccountState> <ClubId>a6af1949-9b9f-4f4a-8d45-162bf986d1f0</ClubId> <EmailConfirmed>true</EmailConfirmed> <ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon> <FriendlyName>sample string 3</FriendlyName> <LanguageId>10</LanguageId> <LastPasswordChangeOn>2024-07-27T08:41:14.4140728+02:00</LastPasswordChangeOn> <NotificationEmail>sample string 4</NotificationEmail> <PersonId>69437d9a-1ccb-431f-abf2-b2af19b5827d</PersonId> <Remarks>sample string 5</Remarks> <UserId>ad36e72c-9d60-4412-bdb9-1bad467af347</UserId> <UserName>sample string 6</UserName> <UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>e3617f6b-7f05-4b7b-9201-5b3374fad462</d2p1:guid> <d2p1:guid>4b82ae84-2697-49d8-bf3b-1386865ba33e</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": "6c8760b4-03e2-47dd-9504-5f6a5375fb33", "ClubId": "f998b37d-d39a-4803-9679-6e61afcc8a88", "FriendlyName": "sample string 3", "NotificationEmail": "sample string 4", "PersonId": "cbfef3d2-22e3-407d-94ce-c435a193298b", "Remarks": "sample string 5", "UserName": "sample string 6", "UserRoleIds": [ "709d8437-e24e-4a55-95d9-170233e81ed9", "1401aa94-cb5b-45c0-9185-0171239a6b90" ], "AccountState": 7, "LastPasswordChangeOn": "2024-07-27T08:41:14.4140728+02:00", "ForcePasswordChangeNextLogon": true, "EmailConfirmed": true, "LanguageId": 10, "Id": "6c8760b4-03e2-47dd-9504-5f6a5375fb33", "CanUpdateRecord": true, "CanDeleteRecord": true }
text/html
Sample:
{"UserId":"6c8760b4-03e2-47dd-9504-5f6a5375fb33","ClubId":"f998b37d-d39a-4803-9679-6e61afcc8a88","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"cbfef3d2-22e3-407d-94ce-c435a193298b","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["709d8437-e24e-4a55-95d9-170233e81ed9","1401aa94-cb5b-45c0-9185-0171239a6b90"],"AccountState":7,"LastPasswordChangeOn":"2024-07-27T08:41:14.4140728+02:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"6c8760b4-03e2-47dd-9504-5f6a5375fb33","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">6c8760b4-03e2-47dd-9504-5f6a5375fb33</Id> <AccountState>7</AccountState> <ClubId>f998b37d-d39a-4803-9679-6e61afcc8a88</ClubId> <EmailConfirmed>true</EmailConfirmed> <ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon> <FriendlyName>sample string 3</FriendlyName> <LanguageId>10</LanguageId> <LastPasswordChangeOn>2024-07-27T08:41:14.4140728+02:00</LastPasswordChangeOn> <NotificationEmail>sample string 4</NotificationEmail> <PersonId>cbfef3d2-22e3-407d-94ce-c435a193298b</PersonId> <Remarks>sample string 5</Remarks> <UserId>6c8760b4-03e2-47dd-9504-5f6a5375fb33</UserId> <UserName>sample string 6</UserName> <UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>709d8437-e24e-4a55-95d9-170233e81ed9</d2p1:guid> <d2p1:guid>1401aa94-cb5b-45c0-9185-0171239a6b90</d2p1:guid> </UserRoleIds> </UserDetails>