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": "995b7f58-a13c-4a9a-af46-ab1a1f34a67c",
"Remarks": "sample string 3",
"UserName": "sample string 4",
"UserRoleIds": [
"16354702-9fbd-470b-a7a4-d13e8acf208b",
"d4328859-63b4-41a5-be9f-e4e252537cc8"
],
"EmailConfirmationLink": "sample string 5"
}
text/html
Sample:
{"FriendlyName":"sample string 1","NotificationEmail":"sample string 2","PersonId":"995b7f58-a13c-4a9a-af46-ab1a1f34a67c","Remarks":"sample string 3","UserName":"sample string 4","UserRoleIds":["16354702-9fbd-470b-a7a4-d13e8acf208b","d4328859-63b4-41a5-be9f-e4e252537cc8"],"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>995b7f58-a13c-4a9a-af46-ab1a1f34a67c</PersonId>
<Remarks>sample string 3</Remarks>
<UserName>sample string 4</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>16354702-9fbd-470b-a7a4-d13e8acf208b</d2p1:guid>
<d2p1:guid>d4328859-63b4-41a5-be9f-e4e252537cc8</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": "f00e6944-8b4d-4391-8686-6dc37169167c",
"ClubId": "17837043-6a3d-4f9f-b940-26cb0d4e2e52",
"FriendlyName": "sample string 3",
"NotificationEmail": "sample string 4",
"PersonId": "3c42c5e2-b9e5-4ed3-8cab-5609496d1e53",
"Remarks": "sample string 5",
"UserName": "sample string 6",
"UserRoleIds": [
"6ec75229-8f48-4b7b-b89e-773d71aee391",
"460207b8-ff99-48a1-9d87-7d1529b9ab65"
],
"AccountState": 7,
"LastPasswordChangeOn": "2026-08-26T21:40:18.3184398+02:00",
"ForcePasswordChangeNextLogon": true,
"EmailConfirmed": true,
"LanguageId": 10,
"Id": "f00e6944-8b4d-4391-8686-6dc37169167c",
"CanUpdateRecord": true,
"CanDeleteRecord": true
}
text/html
Sample:
{"UserId":"f00e6944-8b4d-4391-8686-6dc37169167c","ClubId":"17837043-6a3d-4f9f-b940-26cb0d4e2e52","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"3c42c5e2-b9e5-4ed3-8cab-5609496d1e53","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["6ec75229-8f48-4b7b-b89e-773d71aee391","460207b8-ff99-48a1-9d87-7d1529b9ab65"],"AccountState":7,"LastPasswordChangeOn":"2026-08-26T21:40:18.3184398+02:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"f00e6944-8b4d-4391-8686-6dc37169167c","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">f00e6944-8b4d-4391-8686-6dc37169167c</Id>
<AccountState>7</AccountState>
<ClubId>17837043-6a3d-4f9f-b940-26cb0d4e2e52</ClubId>
<EmailConfirmed>true</EmailConfirmed>
<ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon>
<FriendlyName>sample string 3</FriendlyName>
<LanguageId>10</LanguageId>
<LastPasswordChangeOn>2026-08-26T21:40:18.3184398+02:00</LastPasswordChangeOn>
<NotificationEmail>sample string 4</NotificationEmail>
<PersonId>3c42c5e2-b9e5-4ed3-8cab-5609496d1e53</PersonId>
<Remarks>sample string 5</Remarks>
<UserId>f00e6944-8b4d-4391-8686-6dc37169167c</UserId>
<UserName>sample string 6</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>6ec75229-8f48-4b7b-b89e-773d71aee391</d2p1:guid>
<d2p1:guid>460207b8-ff99-48a1-9d87-7d1529b9ab65</d2p1:guid>
</UserRoleIds>
</UserDetails>