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
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.
ResponseOfListOfUserV2Name | Description | Type | Additional 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": "63ba7984-63b8-427a-b01a-79e72ff43075", "AgreementDate": "2024-09-08T00:21:52.5395308+00:00", "AccountID": "0e2a6014-fff8-4984-9723-65d44cdb9cc8", "AdminUser": true, "DateCreated": "2024-09-08T00:21:52.5395308+00:00", "DateModified": "2024-09-08T00:21:52.5395308+00:00", "DeclineDate": "2024-09-08T00:21:52.5395308+00:00", "DisplayName": "sample string 7", "DPAVersion": "sample string 8", "EmailAddress": "sample string 9", "Enabled": true, "LanguageID": "3741255f-b0c8-4a23-a811-7fcaae0b3cae", "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": "63ba7984-63b8-427a-b01a-79e72ff43075", "AgreementDate": "2024-09-08T00:21:52.5395308+00:00", "AccountID": "0e2a6014-fff8-4984-9723-65d44cdb9cc8", "AdminUser": true, "DateCreated": "2024-09-08T00:21:52.5395308+00:00", "DateModified": "2024-09-08T00:21:52.5395308+00:00", "DeclineDate": "2024-09-08T00:21:52.5395308+00:00", "DisplayName": "sample string 7", "DPAVersion": "sample string 8", "EmailAddress": "sample string 9", "Enabled": true, "LanguageID": "3741255f-b0c8-4a23-a811-7fcaae0b3cae", "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>63ba7984-63b8-427a-b01a-79e72ff43075</ID> <AgreementDate>2024-09-08T00:21:52.5395308+00:00</AgreementDate> <AccountID>0e2a6014-fff8-4984-9723-65d44cdb9cc8</AccountID> <AdminUser>true</AdminUser> <DateCreated>2024-09-08T00:21:52.5395308+00:00</DateCreated> <DateModified>2024-09-08T00:21:52.5395308+00:00</DateModified> <DeclineDate>2024-09-08T00:21:52.5395308+00:00</DeclineDate> <DisplayName>sample string 7</DisplayName> <DPAVersion>sample string 8</DPAVersion> <EmailAddress>sample string 9</EmailAddress> <Enabled>true</Enabled> <LanguageID>3741255f-b0c8-4a23-a811-7fcaae0b3cae</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>63ba7984-63b8-427a-b01a-79e72ff43075</ID> <AgreementDate>2024-09-08T00:21:52.5395308+00:00</AgreementDate> <AccountID>0e2a6014-fff8-4984-9723-65d44cdb9cc8</AccountID> <AdminUser>true</AdminUser> <DateCreated>2024-09-08T00:21:52.5395308+00:00</DateCreated> <DateModified>2024-09-08T00:21:52.5395308+00:00</DateModified> <DeclineDate>2024-09-08T00:21:52.5395308+00:00</DeclineDate> <DisplayName>sample string 7</DisplayName> <DPAVersion>sample string 8</DPAVersion> <EmailAddress>sample string 9</EmailAddress> <Enabled>true</Enabled> <LanguageID>3741255f-b0c8-4a23-a811-7fcaae0b3cae</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>