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

NameDescriptionTypeAdditional 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.

ResponseOfUserV2
NameDescriptionTypeAdditional 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": "861656e7-ff4c-40fc-94cd-d692445867c9",
      "AgreementDate": "2024-12-22T16:23:16.8758219+00:00",
      "AccountID": "1e2f8431-c0cc-4eb2-ac20-178dea72fc2c",
      "AdminUser": true,
      "DateCreated": "2024-12-22T16:23:16.8758219+00:00",
      "DateModified": "2024-12-22T16:23:16.8758219+00:00",
      "DeclineDate": "2024-12-22T16:23:16.8758219+00:00",
      "DisplayName": "sample string 7",
      "DPAVersion": "sample string 8",
      "EmailAddress": "sample string 9",
      "Enabled": true,
      "LanguageID": "1a4f6439-2384-497c-960c-f6fa122121a0",
      "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>861656e7-ff4c-40fc-94cd-d692445867c9</ID>
      <AgreementDate>2024-12-22T16:23:16.8758219+00:00</AgreementDate>
      <AccountID>1e2f8431-c0cc-4eb2-ac20-178dea72fc2c</AccountID>
      <AdminUser>true</AdminUser>
      <DateCreated>2024-12-22T16:23:16.8758219+00:00</DateCreated>
      <DateModified>2024-12-22T16:23:16.8758219+00:00</DateModified>
      <DeclineDate>2024-12-22T16:23:16.8758219+00:00</DeclineDate>
      <DisplayName>sample string 7</DisplayName>
      <DPAVersion>sample string 8</DPAVersion>
      <EmailAddress>sample string 9</EmailAddress>
      <Enabled>true</Enabled>
      <LanguageID>1a4f6439-2384-497c-960c-f6fa122121a0</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>