GET api/v2/admin/users?IncludeSuperUsers={IncludeSuperUsers}

This method retrieves all the users that the authenticated user is allowed to view. The method will return data only if the authenticated user is authorised to access the users, else it will return a HTTP 401 error.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
IncludeSuperUsers

boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

List of users that the authenticated user is allowed to view.

ResponseOfListOfUserV2
NameDescriptionTypeAdditional information
Error

Error

None.

ResponseData

ResponseDataOfListOfUserV2

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": [
      {
        "Status": "sample string 1",
        "ID": "6cad0646-4885-462d-9159-adcb512aa372",
        "AgreementDate": "2022-06-28T12:03:29.2929896+00:00",
        "AccountID": "b02e0158-2a49-4ba4-8146-da742bc700cd",
        "AdminUser": true,
        "DateCreated": "2022-06-28T12:03:29.2929896+00:00",
        "DateModified": "2022-06-28T12:03:29.2929896+00:00",
        "DeclineDate": "2022-06-28T12:03:29.2929896+00:00",
        "DisplayName": "sample string 7",
        "DPAVersion": "sample string 8",
        "EmailAddress": "sample string 9",
        "Enabled": true,
        "LanguageID": "36a472a4-cca6-42e0-82b4-f41cf63f1fbc",
        "MobilePhone": "sample string 13",
        "Password": "sample string 14",
        "Pin": "sample string 15",
        "Preferences": 0,
        "PrivacyPolicyVersion": "sample string 16",
        "SSOEnabled": true,
        "TimeZone": "sample string 18",
        "Username": "sample string 19",
        "UserPassword": "sample string 20"
      },
      {
        "Status": "sample string 1",
        "ID": "6cad0646-4885-462d-9159-adcb512aa372",
        "AgreementDate": "2022-06-28T12:03:29.2929896+00:00",
        "AccountID": "b02e0158-2a49-4ba4-8146-da742bc700cd",
        "AdminUser": true,
        "DateCreated": "2022-06-28T12:03:29.2929896+00:00",
        "DateModified": "2022-06-28T12:03:29.2929896+00:00",
        "DeclineDate": "2022-06-28T12:03:29.2929896+00:00",
        "DisplayName": "sample string 7",
        "DPAVersion": "sample string 8",
        "EmailAddress": "sample string 9",
        "Enabled": true,
        "LanguageID": "36a472a4-cca6-42e0-82b4-f41cf63f1fbc",
        "MobilePhone": "sample string 13",
        "Password": "sample string 14",
        "Pin": "sample string 15",
        "Preferences": 0,
        "PrivacyPolicyVersion": "sample string 16",
        "SSOEnabled": true,
        "TimeZone": "sample string 18",
        "Username": "sample string 19",
        "UserPassword": "sample string 20"
      }
    ]
  }
}

application/xml, text/xml

Sample:
<ResponseOfListOfUserV2 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>
      <UserV2>
        <ID>6cad0646-4885-462d-9159-adcb512aa372</ID>
        <AgreementDate>2022-06-28T12:03:29.2929896+00:00</AgreementDate>
        <AccountID>b02e0158-2a49-4ba4-8146-da742bc700cd</AccountID>
        <AdminUser>true</AdminUser>
        <DateCreated>2022-06-28T12:03:29.2929896+00:00</DateCreated>
        <DateModified>2022-06-28T12:03:29.2929896+00:00</DateModified>
        <DeclineDate>2022-06-28T12:03:29.2929896+00:00</DeclineDate>
        <DisplayName>sample string 7</DisplayName>
        <DPAVersion>sample string 8</DPAVersion>
        <EmailAddress>sample string 9</EmailAddress>
        <Enabled>true</Enabled>
        <LanguageID>36a472a4-cca6-42e0-82b4-f41cf63f1fbc</LanguageID>
        <Language>sample string 12</Language>
        <MobilePhone>sample string 13</MobilePhone>
        <Password>sample string 14</Password>
        <Pin>sample string 15</Pin>
        <Preferences>NONE</Preferences>
        <PrivacyPolicyVersion>sample string 16</PrivacyPolicyVersion>
        <SSOEnabled>true</SSOEnabled>
        <TimeZone>sample string 18</TimeZone>
        <Username>sample string 19</Username>
        <UserPassword>sample string 20</UserPassword>
        <Status>sample string 1</Status>
      </UserV2>
      <UserV2>
        <ID>6cad0646-4885-462d-9159-adcb512aa372</ID>
        <AgreementDate>2022-06-28T12:03:29.2929896+00:00</AgreementDate>
        <AccountID>b02e0158-2a49-4ba4-8146-da742bc700cd</AccountID>
        <AdminUser>true</AdminUser>
        <DateCreated>2022-06-28T12:03:29.2929896+00:00</DateCreated>
        <DateModified>2022-06-28T12:03:29.2929896+00:00</DateModified>
        <DeclineDate>2022-06-28T12:03:29.2929896+00:00</DeclineDate>
        <DisplayName>sample string 7</DisplayName>
        <DPAVersion>sample string 8</DPAVersion>
        <EmailAddress>sample string 9</EmailAddress>
        <Enabled>true</Enabled>
        <LanguageID>36a472a4-cca6-42e0-82b4-f41cf63f1fbc</LanguageID>
        <Language>sample string 12</Language>
        <MobilePhone>sample string 13</MobilePhone>
        <Password>sample string 14</Password>
        <Pin>sample string 15</Pin>
        <Preferences>NONE</Preferences>
        <PrivacyPolicyVersion>sample string 16</PrivacyPolicyVersion>
        <SSOEnabled>true</SSOEnabled>
        <TimeZone>sample string 18</TimeZone>
        <Username>sample string 19</Username>
        <UserPassword>sample string 20</UserPassword>
        <Status>sample string 1</Status>
      </UserV2>
    </Detail>
  </ResponseData>
</ResponseOfListOfUserV2>