GET api/v2/admin/users/{id}
Returns the details of the provided user ID. The logged in user must have permission to perform this action.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id |
The ID of the user to return the details. |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
The user overview information.
ResponseOfUserV2Name | Description | Type | Additional information |
---|---|---|---|
Error | Error |
None. |
|
ResponseData | ResponseDataOfUserV2 |
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": "47b91393-238b-4c31-bd3e-5137beb49d19", "AgreementDate": "2025-05-09T09:16:48.5534999+00:00", "AccountID": "5c7021e9-cd74-4f89-baf4-0aae4abc192c", "AdminUser": true, "DateCreated": "2025-05-09T09:16:48.5534999+00:00", "DateModified": "2025-05-09T09:16:48.5534999+00:00", "DeclineDate": "2025-05-09T09:16:48.5534999+00:00", "DisplayName": "sample string 7", "DPAVersion": "sample string 8", "EmailAddress": "sample string 9", "Enabled": true, "LanguageID": "82e7f2b0-a931-4423-b4e4-57ef2ad9bd2e", "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:
<ResponseOfUserV2 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> <ID>47b91393-238b-4c31-bd3e-5137beb49d19</ID> <AgreementDate>2025-05-09T09:16:48.5534999+00:00</AgreementDate> <AccountID>5c7021e9-cd74-4f89-baf4-0aae4abc192c</AccountID> <AdminUser>true</AdminUser> <DateCreated>2025-05-09T09:16:48.5534999+00:00</DateCreated> <DateModified>2025-05-09T09:16:48.5534999+00:00</DateModified> <DeclineDate>2025-05-09T09:16:48.5534999+00:00</DeclineDate> <DisplayName>sample string 7</DisplayName> <DPAVersion>sample string 8</DPAVersion> <EmailAddress>sample string 9</EmailAddress> <Enabled>true</Enabled> <LanguageID>82e7f2b0-a931-4423-b4e4-57ef2ad9bd2e</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> </Detail> </ResponseData> </ResponseOfUserV2>