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

Name	Description	Type	Additional 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 Data type: EmailAddress
Enabled	Determines the status of the user.	boolean	Required
LanguageID	The Id of the language of the user.	globally unique identifier	Required
MobilePhone	The mobile phone of the user	string	Required Matching regular expression pattern: ^(?=.?\d.?\d.?\d.?\d.*?\d)([+]?)([\d\s-]{5,20})$
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.
SSOEnabled	Determines if the user is part of a SSO setup.	boolean	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": "fd08dd29-1f9d-4d8c-85d1-2fc470278b25",
  "AgreementDate": "2024-11-21T08:36:58.1174655+00:00",
  "AccountID": "1d55ed8d-8802-4f84-af47-c9287bc10ef2",
  "AdminUser": true,
  "DateCreated": "2024-11-21T08:36:58.1184704+00:00",
  "DateModified": "2024-11-21T08:36:58.1184704+00:00",
  "DeclineDate": "2024-11-21T08:36:58.1184704+00:00",
  "DisplayName": "sample string 6",
  "DPAVersion": "sample string 7",
  "EmailAddress": "sample string 8",
  "Enabled": true,
  "LanguageID": "42ad5055-0cf4-4404-95c2-f1002aca9d91",
  "MobilePhone": "sample string 12",
  "Password": "sample string 13",
  "Pin": "sample string 14",
  "Preferences": 0,
  "PrivacyPolicyVersion": "sample string 15",
  "SSOEnabled": true,
  "TimeZone": "sample string 17",
  "Username": "sample string 18",
  "UserPassword": "sample string 19"
}

application/xml, text/xml

Sample:

<User xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ID>fd08dd29-1f9d-4d8c-85d1-2fc470278b25</ID>
  <AgreementDate>2024-11-21T08:36:58.1174655+00:00</AgreementDate>
  <AccountID>1d55ed8d-8802-4f84-af47-c9287bc10ef2</AccountID>
  <AdminUser>true</AdminUser>
  <DateCreated>2024-11-21T08:36:58.1184704+00:00</DateCreated>
  <DateModified>2024-11-21T08:36:58.1184704+00:00</DateModified>
  <DeclineDate>2024-11-21T08:36:58.1184704+00:00</DeclineDate>
  <DisplayName>sample string 6</DisplayName>
  <DPAVersion>sample string 7</DPAVersion>
  <EmailAddress>sample string 8</EmailAddress>
  <Enabled>true</Enabled>
  <LanguageID>42ad5055-0cf4-4404-95c2-f1002aca9d91</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>
  <SSOEnabled>true</SSOEnabled>
  <TimeZone>sample string 17</TimeZone>
  <Username>sample string 18</Username>
  <UserPassword>sample string 19</UserPassword>
</User>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The new user details with corresponding ID.

ResponseOfUser

Name	Description	Type	Additional 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": "5315271e-9341-4566-9b94-89e7e55d3850",
      "AgreementDate": "2024-11-21T08:36:58.1290417+00:00",
      "AccountID": "fe1b2672-4b68-424f-a201-60b4c4053051",
      "AdminUser": true,
      "DateCreated": "2024-11-21T08:36:58.1290417+00:00",
      "DateModified": "2024-11-21T08:36:58.1290417+00:00",
      "DeclineDate": "2024-11-21T08:36:58.1290417+00:00",
      "DisplayName": "sample string 6",
      "DPAVersion": "sample string 7",
      "EmailAddress": "sample string 8",
      "Enabled": true,
      "LanguageID": "8e7e9e5d-89cf-4aaf-9943-ce25748fa713",
      "MobilePhone": "sample string 12",
      "Password": "sample string 13",
      "Pin": "sample string 14",
      "Preferences": 0,
      "PrivacyPolicyVersion": "sample string 15",
      "SSOEnabled": true,
      "TimeZone": "sample string 17",
      "Username": "sample string 18",
      "UserPassword": "sample string 19"
    }
  }
}

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>5315271e-9341-4566-9b94-89e7e55d3850</ID>
      <AgreementDate>2024-11-21T08:36:58.1290417+00:00</AgreementDate>
      <AccountID>fe1b2672-4b68-424f-a201-60b4c4053051</AccountID>
      <AdminUser>true</AdminUser>
      <DateCreated>2024-11-21T08:36:58.1290417+00:00</DateCreated>
      <DateModified>2024-11-21T08:36:58.1290417+00:00</DateModified>
      <DeclineDate>2024-11-21T08:36:58.1290417+00:00</DeclineDate>
      <DisplayName>sample string 6</DisplayName>
      <DPAVersion>sample string 7</DPAVersion>
      <EmailAddress>sample string 8</EmailAddress>
      <Enabled>true</Enabled>
      <LanguageID>8e7e9e5d-89cf-4aaf-9943-ce25748fa713</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>
      <SSOEnabled>true</SSOEnabled>
      <TimeZone>sample string 17</TimeZone>
      <Username>sample string 18</Username>
      <UserPassword>sample string 19</UserPassword>
    </Detail>
  </ResponseData>
</ResponseOfUser>