POST api/v1/admin/users

Creates a new user to the logged in account. The logged in user must have permission to perform this action. The method performs various checks before creating the new user.

Request Information

URI Parameters

None.

Body Parameters

The new user details to be created.

User
NameDescriptionTypeAdditional information
ID

The unique identifier for the user.

globally unique identifier

None.

AgreementDate

The date the user accepted the privacy policy and data processing agreement. This field is read-only.

date

None.

AccountID

The unique identifier for the account.

globally unique identifier

None.

AdminUser

Determines if the user is an admin user.

boolean

None.

DateCreated

The date the user account was created.

date

None.

DateModified

The date the user account was last modified.

date

None.

DeclineDate

The date the user declined the privacy policy and data processing agreement. This field is read-only.

date

None.

DisplayName

The name of the user.

string

Required

DPAVersion

The version of the data processing agreement that the user has accepted. This field is only read-only.

string

None.

EmailAddress

The email address of the user.

string

Required

Enabled

boolean

Required

LanguageID

The Id of the language of the user.

globally unique identifier

Required

MobilePhone

The mobile phone of the user

string

Required

Password

The password of the user.

string

None.

Pin

Sets the security pin when two factor has been enable. Set it to null if you want it to randonly generate each login.

string

None.

Preferences

Preferences

None.

PrivacyPolicyVersion

The version of the privacy policy that the user has accepted. This field is only read-only.

string

None.

TimeZone

The timezone of the user.

string

Required

Username

The username of the user to log into the system.

string

Required

Request Formats

application/json, text/json

Sample:
{
  "ID": "d5158324-77fa-4981-b80c-939d6849716f",
  "AgreementDate": "2018-08-21T09:32:55.2256166+01:00",
  "AccountID": "9e6bc8bc-33aa-4dd7-8f25-e3852680f2ab",
  "AdminUser": true,
  "DateCreated": "2018-08-21T09:32:55.2256166+01:00",
  "DateModified": "2018-08-21T09:32:55.2256166+01:00",
  "DeclineDate": "2018-08-21T09:32:55.2256166+01:00",
  "DisplayName": "sample string 6",
  "DPAVersion": "sample string 7",
  "EmailAddress": "sample string 8",
  "Enabled": true,
  "LanguageID": "73a5e3e2-b648-4a7e-835d-51344f6ea4a6",
  "MobilePhone": "sample string 12",
  "Password": "sample string 13",
  "Pin": "sample string 14",
  "Preferences": 0,
  "PrivacyPolicyVersion": "sample string 15",
  "TimeZone": "sample string 16",
  "Username": "sample string 17"
}

application/xml, text/xml

Sample:
<User xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ID>d5158324-77fa-4981-b80c-939d6849716f</ID>
  <AgreementDate>2018-08-21T09:32:55.2256166+01:00</AgreementDate>
  <AccountID>9e6bc8bc-33aa-4dd7-8f25-e3852680f2ab</AccountID>
  <AdminUser>true</AdminUser>
  <DateCreated>2018-08-21T09:32:55.2256166+01:00</DateCreated>
  <DateModified>2018-08-21T09:32:55.2256166+01:00</DateModified>
  <DeclineDate>2018-08-21T09:32:55.2256166+01:00</DeclineDate>
  <DisplayName>sample string 6</DisplayName>
  <DPAVersion>sample string 7</DPAVersion>
  <EmailAddress>sample string 8</EmailAddress>
  <Enabled>true</Enabled>
  <LanguageID>73a5e3e2-b648-4a7e-835d-51344f6ea4a6</LanguageID>
  <Language>sample string 11</Language>
  <MobilePhone>sample string 12</MobilePhone>
  <Password>sample string 13</Password>
  <Pin>sample string 14</Pin>
  <Preferences>NONE</Preferences>
  <PrivacyPolicyVersion>sample string 15</PrivacyPolicyVersion>
  <TimeZone>sample string 16</TimeZone>
  <Username>sample string 17</Username>
</User>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The new user details with corresponding ID.

ResponseOfUser
NameDescriptionTypeAdditional information
Error

Error

None.

ResponseData

ResponseDataOfUser

None.

Response Formats

application/json, text/json

Sample:
{
  "Error": {
    "ErrorCode": "sample string 1",
    "ErrorReason": "sample string 2"
  },
  "ResponseData": {
    "Identification": {
      "UserId": "sample string 1"
    },
    "Result": "sample string 1",
    "Detail": {
      "ID": "d057f9ad-468c-47ec-957b-7076f545e573",
      "AgreementDate": "2018-08-21T09:32:55.2256166+01:00",
      "AccountID": "d3cf326a-ef58-4d83-89d4-bd62930bdaa8",
      "AdminUser": true,
      "DateCreated": "2018-08-21T09:32:55.2256166+01:00",
      "DateModified": "2018-08-21T09:32:55.2256166+01:00",
      "DeclineDate": "2018-08-21T09:32:55.2256166+01:00",
      "DisplayName": "sample string 6",
      "DPAVersion": "sample string 7",
      "EmailAddress": "sample string 8",
      "Enabled": true,
      "LanguageID": "c9a99e29-0515-4719-a5cf-04fef6c1083d",
      "MobilePhone": "sample string 12",
      "Password": "sample string 13",
      "Pin": "sample string 14",
      "Preferences": 0,
      "PrivacyPolicyVersion": "sample string 15",
      "TimeZone": "sample string 16",
      "Username": "sample string 17"
    }
  }
}

application/xml, text/xml

Sample:
<ResponseOfUser xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Error>
    <ErrorCode>sample string 1</ErrorCode>
    <ErrorReason>sample string 2</ErrorReason>
  </Error>
  <ResponseData>
    <Result>sample string 1</Result>
    <Identification>
      <UserId>sample string 1</UserId>
    </Identification>
    <Detail>
      <ID>d057f9ad-468c-47ec-957b-7076f545e573</ID>
      <AgreementDate>2018-08-21T09:32:55.2256166+01:00</AgreementDate>
      <AccountID>d3cf326a-ef58-4d83-89d4-bd62930bdaa8</AccountID>
      <AdminUser>true</AdminUser>
      <DateCreated>2018-08-21T09:32:55.2256166+01:00</DateCreated>
      <DateModified>2018-08-21T09:32:55.2256166+01:00</DateModified>
      <DeclineDate>2018-08-21T09:32:55.2256166+01:00</DeclineDate>
      <DisplayName>sample string 6</DisplayName>
      <DPAVersion>sample string 7</DPAVersion>
      <EmailAddress>sample string 8</EmailAddress>
      <Enabled>true</Enabled>
      <LanguageID>c9a99e29-0515-4719-a5cf-04fef6c1083d</LanguageID>
      <Language>sample string 11</Language>
      <MobilePhone>sample string 12</MobilePhone>
      <Password>sample string 13</Password>
      <Pin>sample string 14</Pin>
      <Preferences>NONE</Preferences>
      <PrivacyPolicyVersion>sample string 15</PrivacyPolicyVersion>
      <TimeZone>sample string 16</TimeZone>
      <Username>sample string 17</Username>
    </Detail>
  </ResponseData>
</ResponseOfUser>