POST api/v1/authentication/account/users

Used to register user in system

Request Information

URI Parameters

None.

Body Parameters

Com.Healthbridge.Hhas.Authentication.Impl.ValueObjects.UserVo
NameDescriptionTypeAdditional information
UserId

User identifier

 globally unique identifier

None.
Username

User name

 string

None.
Password

User password

 string

None.
PasswordHash

string

None.
FullName

Friendly user name

 string

None.
LockedUntil

Indicate if user was locked and until when

 date

None.
ExpirationTime

date

None.
Claims

User claim roles

 Collection of Com.Healthbridge.Hhas.Authentication.Impl.ValueObjects.ClaimVo

None.
RequirePasswordChange

Flag indicating that user must change the password on next login

 boolean

None.

Request Formats

application/json, text/json

Sample: 
{
  "UserId": "1fab69e0-6af3-462d-bcae-f5b5b652fd8c",
  "Username": "sample string 2",
  "Password": "sample string 3",
  "PasswordHash": "sample string 4",
  "FullName": "sample string 5",
  "LockedUntil": "2025-11-21T13:38:42Z",
  "ExpirationTime": "2025-11-21T13:38:42Z",
  "Claims": [
    {
      "ClaimType": "sample string 2",
      "ClaimValue": "sample string 3",
      "ClaimScope": "sample string 4"
    },
    {
      "ClaimType": "sample string 2",
      "ClaimValue": "sample string 3",
      "ClaimScope": "sample string 4"
    }
  ],
  "RequirePasswordChange": true
}

application/xml, text/xml

Sample: 
<UserVo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Hhas.Authentication.Impl.ValueObjects">
  <Claims>
    <ClaimVo>
      <ClaimScope>sample string 4</ClaimScope>
      <ClaimType>sample string 2</ClaimType>
      <ClaimValue>sample string 3</ClaimValue>
    </ClaimVo>
    <ClaimVo>
      <ClaimScope>sample string 4</ClaimScope>
      <ClaimType>sample string 2</ClaimType>
      <ClaimValue>sample string 3</ClaimValue>
    </ClaimVo>
  </Claims>
  <ExpirationTime>2025-11-21T13:38:42.1874426+02:00</ExpirationTime>
  <FullName>sample string 5</FullName>
  <LockedUntil>2025-11-21T13:38:42.1874426+02:00</LockedUntil>
  <Password>sample string 3</Password>
  <PasswordHash>sample string 4</PasswordHash>
  <RequirePasswordChange>true</RequirePasswordChange>
  <UserId>1fab69e0-6af3-462d-bcae-f5b5b652fd8c</UserId>
  <Username>sample string 2</Username>
</UserVo>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'System.Web.Http.ModelBinding.JQueryMvcFormUrlEncodedFormatter' to write type 'UserVo'.

Response Information

Resource Description

Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects.RestApiResultOfSystem.Guid
NameDescriptionTypeAdditional information
Sucess

boolean

None.
ResponseCode

integer

None.
ResponseMessage

string

None.
Data

globally unique identifier

None.
Links

Collection of Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects.RestApiLink

None.

Response Formats

application/json, text/json

Sample: 
{
  "Sucess": true,
  "ResponseCode": 2,
  "ResponseMessage": "sample string 3",
  "Data": "7d5376b4-b2f2-4232-a6b3-e8d6b3686e98",
  "Links": [
    {
      "Rel": "sample string 1",
      "HRef": "sample string 2"
    },
    {
      "Rel": "sample string 1",
      "HRef": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample: 
<RestApiResultOfguid xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects">
  <Data>7d5376b4-b2f2-4232-a6b3-e8d6b3686e98</Data>
  <Links>
    <RestApiLink>
      <HRef>sample string 2</HRef>
      <Rel>sample string 1</Rel>
    </RestApiLink>
    <RestApiLink>
      <HRef>sample string 2</HRef>
      <Rel>sample string 1</Rel>
    </RestApiLink>
  </Links>
  <ResponseCode>2</ResponseCode>
  <ResponseMessage>sample string 3</ResponseMessage>
  <Sucess>true</Sucess>
</RestApiResultOfguid>