POST api/v1/users
Request Information
URI Parameters
None.
Body Parameters
UserRegistrationDetails| Name | Description | Type | Additional information |
|---|---|---|---|
| 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. |
|
| EmailConfirmationLink | string |
Required String length: inclusive between 0 and 256 |
Request Formats
application/json, text/json
Sample:
{
"FriendlyName": "sample string 1",
"NotificationEmail": "sample string 2",
"PersonId": "9e6225ea-ec70-467b-a876-d29ececc6e34",
"Remarks": "sample string 3",
"UserName": "sample string 4",
"UserRoleIds": [
"4f99b72d-be01-4dfe-ab53-06e00d9d1dc5",
"c1cb6038-28a3-42af-a747-94298e9d2299"
],
"EmailConfirmationLink": "sample string 5"
}
text/html
Sample:
{"FriendlyName":"sample string 1","NotificationEmail":"sample string 2","PersonId":"9e6225ea-ec70-467b-a876-d29ececc6e34","Remarks":"sample string 3","UserName":"sample string 4","UserRoleIds":["4f99b72d-be01-4dfe-ab53-06e00d9d1dc5","c1cb6038-28a3-42af-a747-94298e9d2299"],"EmailConfirmationLink":"sample string 5"}
application/xml, text/xml
Sample:
<UserRegistrationDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi.User">
<EmailConfirmationLink>sample string 5</EmailConfirmationLink>
<FriendlyName>sample string 1</FriendlyName>
<NotificationEmail>sample string 2</NotificationEmail>
<PersonId>9e6225ea-ec70-467b-a876-d29ececc6e34</PersonId>
<Remarks>sample string 3</Remarks>
<UserName>sample string 4</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>4f99b72d-be01-4dfe-ab53-06e00d9d1dc5</d2p1:guid>
<d2p1:guid>c1cb6038-28a3-42af-a747-94298e9d2299</d2p1:guid>
</UserRoleIds>
</UserRegistrationDetails>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
UserDetails| Name | 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": "9a401d14-c2d0-41a8-95a3-bc2d24d5e1ee",
"ClubId": "a1d295d4-5131-4bff-a886-db7796f412e7",
"FriendlyName": "sample string 3",
"NotificationEmail": "sample string 4",
"PersonId": "2cab2f19-bf0f-4503-a9d7-0481543f8b3e",
"Remarks": "sample string 5",
"UserName": "sample string 6",
"UserRoleIds": [
"67e763a1-6a36-4fd9-b6ce-9e98d57150c7",
"18cfa3fb-f544-4b47-a4bd-79793439530a"
],
"AccountState": 7,
"LastPasswordChangeOn": "2025-11-15T10:17:15.9968752+01:00",
"ForcePasswordChangeNextLogon": true,
"EmailConfirmed": true,
"LanguageId": 10,
"Id": "9a401d14-c2d0-41a8-95a3-bc2d24d5e1ee",
"CanUpdateRecord": true,
"CanDeleteRecord": true
}
text/html
Sample:
{"UserId":"9a401d14-c2d0-41a8-95a3-bc2d24d5e1ee","ClubId":"a1d295d4-5131-4bff-a886-db7796f412e7","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"2cab2f19-bf0f-4503-a9d7-0481543f8b3e","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["67e763a1-6a36-4fd9-b6ce-9e98d57150c7","18cfa3fb-f544-4b47-a4bd-79793439530a"],"AccountState":7,"LastPasswordChangeOn":"2025-11-15T10:17:15.9968752+01:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"9a401d14-c2d0-41a8-95a3-bc2d24d5e1ee","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">9a401d14-c2d0-41a8-95a3-bc2d24d5e1ee</Id>
<AccountState>7</AccountState>
<ClubId>a1d295d4-5131-4bff-a886-db7796f412e7</ClubId>
<EmailConfirmed>true</EmailConfirmed>
<ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon>
<FriendlyName>sample string 3</FriendlyName>
<LanguageId>10</LanguageId>
<LastPasswordChangeOn>2025-11-15T10:17:15.9968752+01:00</LastPasswordChangeOn>
<NotificationEmail>sample string 4</NotificationEmail>
<PersonId>2cab2f19-bf0f-4503-a9d7-0481543f8b3e</PersonId>
<Remarks>sample string 5</Remarks>
<UserId>9a401d14-c2d0-41a8-95a3-bc2d24d5e1ee</UserId>
<UserName>sample string 6</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>67e763a1-6a36-4fd9-b6ce-9e98d57150c7</d2p1:guid>
<d2p1:guid>18cfa3fb-f544-4b47-a4bd-79793439530a</d2p1:guid>
</UserRoleIds>
</UserDetails>