POST /external/api/v3/user

Add a user.

Request Information

URI Parameters

None.

Body Parameters

Collection of ImportUser
NameDescriptionTypeAdditional informationNullable
Email

string

None

False
Roles

Collection of BaseRole

Required

False
Username

string

Required

False
Type

Internal or external.

string

Required

False
HasSingleActiveRole

boolean

None

False

Request Formats

application/json

Sample:
[
  {
    "Username": "sample string 2",
    "Email": "sample string 1",
    "Roles": [
      {
        "Id": "a550f894-22b2-426c-a5e7-ece38a180c79"
      },
      {
        "Id": "a550f894-22b2-426c-a5e7-ece38a180c79"
      }
    ],
    "Type": "sample string 3",
    "HasSingleActiveRole": true
  },
  {
    "Username": "sample string 2",
    "Email": "sample string 1",
    "Roles": [
      {
        "Id": "a550f894-22b2-426c-a5e7-ece38a180c79"
      },
      {
        "Id": "a550f894-22b2-426c-a5e7-ece38a180c79"
      }
    ],
    "Type": "sample string 3",
    "HasSingleActiveRole": true
  }
]

application/xml

Sample:
<ArrayOfImportUser xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.V1.Models">
  <ImportUser>
    <HasSingleActiveRole xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models">true</HasSingleActiveRole>
    <Type xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models">sample string 3</Type>
    <Username xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models">sample string 2</Username>
    <Email>sample string 1</Email>
    <Roles xmlns:d3p1="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models">
      <d3p1:BaseRole>
        <d3p1:Id>a550f894-22b2-426c-a5e7-ece38a180c79</d3p1:Id>
      </d3p1:BaseRole>
      <d3p1:BaseRole>
        <d3p1:Id>a550f894-22b2-426c-a5e7-ece38a180c79</d3p1:Id>
      </d3p1:BaseRole>
    </Roles>
  </ImportUser>
  <ImportUser>
    <HasSingleActiveRole xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models">true</HasSingleActiveRole>
    <Type xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models">sample string 3</Type>
    <Username xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models">sample string 2</Username>
    <Email>sample string 1</Email>
    <Roles xmlns:d3p1="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models">
      <d3p1:BaseRole>
        <d3p1:Id>a550f894-22b2-426c-a5e7-ece38a180c79</d3p1:Id>
      </d3p1:BaseRole>
      <d3p1:BaseRole>
        <d3p1:Id>a550f894-22b2-426c-a5e7-ece38a180c79</d3p1:Id>
      </d3p1:BaseRole>
    </Roles>
  </ImportUser>
</ArrayOfImportUser>

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.

Response Status Codes

Status Code Name Description
200 OK The request has succeeded.
400 Bad Request Fulfilling the request would cause an invalid state. Request needs modification.
401 Unauthorized Missing or invalid authentication token.
403 Forbidden Server refuses to authorize the request.
408 Request Timeout The server timed out waiting for the request.
429 Too Many Requests Too many requests in a given amount of time.
500 Internal Server Error The server encountered an unexpected condition which prevented it from fulfilling the request.
503 Service Unavailable The server is unable to proces the request at the moment, try again later.