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

TwoSms.CustomerPortalRole.API.Misc.ResponseOfTwoSms.CustomerPortalRole.API.Admin.Users.User

Name	Description	Type	Additional information
Error		TwoSms.CustomerPortalRole.API.Misc.Error	None.
ResponseData		TwoSms.CustomerPortalRole.API.Misc.ResponseDataOfTwoSms.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": "59d8e7ff-9bcb-4f5e-bf84-76d2b5ac0c96",
      "AgreementDate": "2024-11-21T09:24:42.2048875+00:00",
      "AccountID": "91d9ac48-24fa-45a8-b328-14950e2f9a09",
      "AdminUser": true,
      "DateCreated": "2024-11-21T09:24:42.2048875+00:00",
      "DateModified": "2024-11-21T09:24:42.2048875+00:00",
      "DeclineDate": "2024-11-21T09:24:42.2048875+00:00",
      "DisplayName": "sample string 6",
      "DPAVersion": "sample string 7",
      "EmailAddress": "sample string 8",
      "Enabled": true,
      "LanguageID": "5162beb9-5268-4e64-89bc-f4ebbb731611",
      "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:

<ResponseOfUser 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>59d8e7ff-9bcb-4f5e-bf84-76d2b5ac0c96</ID>
      <AgreementDate>2024-11-21T09:24:42.2048875+00:00</AgreementDate>
      <AccountID>91d9ac48-24fa-45a8-b328-14950e2f9a09</AccountID>
      <AdminUser>true</AdminUser>
      <DateCreated>2024-11-21T09:24:42.2048875+00:00</DateCreated>
      <DateModified>2024-11-21T09:24:42.2048875+00:00</DateModified>
      <DeclineDate>2024-11-21T09:24:42.2048875+00:00</DeclineDate>
      <DisplayName>sample string 6</DisplayName>
      <DPAVersion>sample string 7</DPAVersion>
      <EmailAddress>sample string 8</EmailAddress>
      <Enabled>true</Enabled>
      <LanguageID>5162beb9-5268-4e64-89bc-f4ebbb731611</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>
    </Detail>
  </ResponseData>
</ResponseOfUser>