GET api/v1/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

Name	Description	Type	Additional 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.

TwoSms.CustomerPortalRole.API.Misc.ResponseOfSystem.Collections.Generic.ListOfTwoSms.CustomerPortalRole.API.Admin.Users.User

Name	Description	Type	Additional information
Error		TwoSms.CustomerPortalRole.API.Misc.Error	None.
ResponseData		TwoSms.CustomerPortalRole.API.Misc.ResponseDataOfSystem.Collections.Generic.ListOfTwoSms.CustomerPortalRole.API.Admin.Users.User	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": "2a1a85a2-abaf-4920-ab7d-050cfaacb34e",
        "AgreementDate": "2024-04-19T22:17:41.2079522+00:00",
        "AccountID": "79c7ec0e-4e6b-482c-8f36-1a0843f8664c",
        "AdminUser": true,
        "DateCreated": "2024-04-19T22:17:41.2079522+00:00",
        "DateModified": "2024-04-19T22:17:41.2079522+00:00",
        "DeclineDate": "2024-04-19T22:17:41.2079522+00:00",
        "DisplayName": "sample string 6",
        "DPAVersion": "sample string 7",
        "EmailAddress": "sample string 8",
        "Enabled": true,
        "LanguageID": "e7f8e0a3-dd0d-4500-82a5-2aa7278833af",
        "MobilePhone": "sample string 12",
        "Password": "sample string 13",
        "Pin": "sample string 14",
        "Preferences": 0,
        "PrivacyPolicyVersion": "sample string 15",
        "TimeZone": "sample string 16",
        "Username": "sample string 17"
      },
      {
        "ID": "2a1a85a2-abaf-4920-ab7d-050cfaacb34e",
        "AgreementDate": "2024-04-19T22:17:41.2079522+00:00",
        "AccountID": "79c7ec0e-4e6b-482c-8f36-1a0843f8664c",
        "AdminUser": true,
        "DateCreated": "2024-04-19T22:17:41.2079522+00:00",
        "DateModified": "2024-04-19T22:17:41.2079522+00:00",
        "DeclineDate": "2024-04-19T22:17:41.2079522+00:00",
        "DisplayName": "sample string 6",
        "DPAVersion": "sample string 7",
        "EmailAddress": "sample string 8",
        "Enabled": true,
        "LanguageID": "e7f8e0a3-dd0d-4500-82a5-2aa7278833af",
        "MobilePhone": "sample string 12",
        "Password": "sample string 13",
        "Pin": "sample string 14",
        "Preferences": 0,
        "PrivacyPolicyVersion": "sample string 15",
        "TimeZone": "sample string 16",
        "Username": "sample string 17"
      }
    ]
  }
}

application/xml, text/xml

Sample:

<ResponseOfListOfUser 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>
      <User>
        <ID>2a1a85a2-abaf-4920-ab7d-050cfaacb34e</ID>
        <AgreementDate>2024-04-19T22:17:41.2079522+00:00</AgreementDate>
        <AccountID>79c7ec0e-4e6b-482c-8f36-1a0843f8664c</AccountID>
        <AdminUser>true</AdminUser>
        <DateCreated>2024-04-19T22:17:41.2079522+00:00</DateCreated>
        <DateModified>2024-04-19T22:17:41.2079522+00:00</DateModified>
        <DeclineDate>2024-04-19T22:17:41.2079522+00:00</DeclineDate>
        <DisplayName>sample string 6</DisplayName>
        <DPAVersion>sample string 7</DPAVersion>
        <EmailAddress>sample string 8</EmailAddress>
        <Enabled>true</Enabled>
        <LanguageID>e7f8e0a3-dd0d-4500-82a5-2aa7278833af</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>
        <TimeZone>sample string 16</TimeZone>
        <Username>sample string 17</Username>
      </User>
      <User>
        <ID>2a1a85a2-abaf-4920-ab7d-050cfaacb34e</ID>
        <AgreementDate>2024-04-19T22:17:41.2079522+00:00</AgreementDate>
        <AccountID>79c7ec0e-4e6b-482c-8f36-1a0843f8664c</AccountID>
        <AdminUser>true</AdminUser>
        <DateCreated>2024-04-19T22:17:41.2079522+00:00</DateCreated>
        <DateModified>2024-04-19T22:17:41.2079522+00:00</DateModified>
        <DeclineDate>2024-04-19T22:17:41.2079522+00:00</DeclineDate>
        <DisplayName>sample string 6</DisplayName>
        <DPAVersion>sample string 7</DPAVersion>
        <EmailAddress>sample string 8</EmailAddress>
        <Enabled>true</Enabled>
        <LanguageID>e7f8e0a3-dd0d-4500-82a5-2aa7278833af</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>
        <TimeZone>sample string 16</TimeZone>
        <Username>sample string 17</Username>
      </User>
    </Detail>
  </ResponseData>
</ResponseOfListOfUser>