GET /external/api/v3/user

Get a list of all users and their roles.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of UserModel

Name	Description	Type	Additional information	Nullable
Roles		Collection of RoleModel	None	False
Username		string	Required	False
Type	Internal or external.	string	Required	False
HasSingleActiveRole		boolean	None	False

Response Formats

application/json, text/json

Sample:

[
  {
    "Username": "sample string 1",
    "Roles": [
      {
        "Name": "sample string 1",
        "Id": "aceabd24-ea53-4e9c-b324-e15fa1fee6f7"
      },
      {
        "Name": "sample string 1",
        "Id": "aceabd24-ea53-4e9c-b324-e15fa1fee6f7"
      }
    ],
    "Type": "sample string 2",
    "HasSingleActiveRole": true
  },
  {
    "Username": "sample string 1",
    "Roles": [
      {
        "Name": "sample string 1",
        "Id": "aceabd24-ea53-4e9c-b324-e15fa1fee6f7"
      },
      {
        "Name": "sample string 1",
        "Id": "aceabd24-ea53-4e9c-b324-e15fa1fee6f7"
      }
    ],
    "Type": "sample string 2",
    "HasSingleActiveRole": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfUserModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.V1.Models">
  <UserModel>
    <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 2</Type>
    <Username xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models">sample string 1</Username>
    <Roles xmlns:d3p1="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models">
      <d3p1:RoleModel>
        <d3p1:Id>aceabd24-ea53-4e9c-b324-e15fa1fee6f7</d3p1:Id>
        <d3p1:Name>sample string 1</d3p1:Name>
      </d3p1:RoleModel>
      <d3p1:RoleModel>
        <d3p1:Id>aceabd24-ea53-4e9c-b324-e15fa1fee6f7</d3p1:Id>
        <d3p1:Name>sample string 1</d3p1:Name>
      </d3p1:RoleModel>
    </Roles>
  </UserModel>
  <UserModel>
    <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 2</Type>
    <Username xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models">sample string 1</Username>
    <Roles xmlns:d3p1="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models">
      <d3p1:RoleModel>
        <d3p1:Id>aceabd24-ea53-4e9c-b324-e15fa1fee6f7</d3p1:Id>
        <d3p1:Name>sample string 1</d3p1:Name>
      </d3p1:RoleModel>
      <d3p1:RoleModel>
        <d3p1:Id>aceabd24-ea53-4e9c-b324-e15fa1fee6f7</d3p1:Id>
        <d3p1:Name>sample string 1</d3p1:Name>
      </d3p1:RoleModel>
    </Roles>
  </UserModel>
</ArrayOfUserModel>

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.