POST /users

Registers users with the edoc system.

Authentication and Authorisation

Requires API Access Token Requires Basic Authentication (Username/Password) Requires one of the following roles
True True BusinessAdministrator

Request Information

Parameters

Name Source Description
users Part of the request HTTP body The users.

Parameter Properties

  • users
    Each item has the following properties:
    • Id
      edoc generated unique identifier for the user.
    • Email
      Email address for the user.
      Remarks: Mandatory.
    • FullName
      Full name of the user.
      Remarks: Mandatory.
    • Roles
      The user's roles on edoc.
      Remarks: Mandatory when updating a user. When modifying, ensure that you have the correct privileges.
    • UserName
      Unique username of the user.
      Remarks: Mandatory.

Request body formats

Sample:
[
  {
    "Id": "5b96148b-b4f1-418a-ae2d-e0827f0e4f1b",
    "Email": "Example 1",
    "FullName": "Example 2",
    "Roles": [
      "BusinessAdministrator",
      "BusinessAdministrator",
      "BusinessAdministrator"
    ],
    "UserName": "Example 3"
  },
  {
    "Id": "5b96148b-b4f1-418a-ae2d-e0827f0e4f1b",
    "Email": "Example 1",
    "FullName": "Example 2",
    "Roles": [
      "BusinessAdministrator",
      "BusinessAdministrator",
      "BusinessAdministrator"
    ],
    "UserName": "Example 3"
  },
  {
    "Id": "5b96148b-b4f1-418a-ae2d-e0827f0e4f1b",
    "Email": "Example 1",
    "FullName": "Example 2",
    "Roles": [
      "BusinessAdministrator",
      "BusinessAdministrator",
      "BusinessAdministrator"
    ],
    "UserName": "Example 3"
  }
]
Sample:
<ArrayOfUser xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="edoc">
  <User>
    <Email>Example 1</Email>
    <FullName>Example 2</FullName>
    <Id>5b96148b-b4f1-418a-ae2d-e0827f0e4f1b</Id>
    <Roles>
      <RoleType>BusinessAdministrator</RoleType>
      <RoleType>BusinessAdministrator</RoleType>
      <RoleType>BusinessAdministrator</RoleType>
    </Roles>
    <UserName>Example 3</UserName>
  </User>
  <User>
    <Email>Example 1</Email>
    <FullName>Example 2</FullName>
    <Id>5b96148b-b4f1-418a-ae2d-e0827f0e4f1b</Id>
    <Roles>
      <RoleType>BusinessAdministrator</RoleType>
      <RoleType>BusinessAdministrator</RoleType>
      <RoleType>BusinessAdministrator</RoleType>
    </Roles>
    <UserName>Example 3</UserName>
  </User>
  <User>
    <Email>Example 1</Email>
    <FullName>Example 2</FullName>
    <Id>5b96148b-b4f1-418a-ae2d-e0827f0e4f1b</Id>
    <Roles>
      <RoleType>BusinessAdministrator</RoleType>
      <RoleType>BusinessAdministrator</RoleType>
      <RoleType>BusinessAdministrator</RoleType>
    </Roles>
    <UserName>Example 3</UserName>
  </User>
</ArrayOfUser>