GET v1/core/Channels/{chnId}/users?username={username}&expand={expand}

Returns a user from the Channel for the specified username

Request Information

Parameters

NameDescriptionAdditional information
chnId
The Channel the user belongs to

Define this parameter in the request URI.

username
The username of the user

Define this parameter in the request URI.

expand
optinal query string provided parameter to return resourceIDs

Define this parameter in the request URI.

Response Information

Response body formats

application/json, text/json

Sample:
{
  "Success": true,
  "Data": {
    "ID": 1,
    "AccountID": 2,
    "Username": "sample string 3",
    "Email": "sample string 4",
    "Status": "Enabled",
    "Auth": "ServicePassword",
    "PasswordInfo": {
      "Password": "sample string 1",
      "MaxDenials": 2,
      "ResetPeriod": 3
    },
    "SSOInfo": {
      "PrivateUsername": "sample string 1"
    },
    "AccessTypes": [
      "IPSec_L2TP",
      "IPSec_L2TP",
      "IPSec_L2TP"
    ],
    "VoucherID": 5,
    "ResourceIDs": {
      "IPSec_L2TP": "3eb25d28-b932-4385-a875-d5fb492b96b1"
    },
    "ProvisioningID": "3eb1b285-c783-4df0-b829-3bd77d247b0c"
  },
  "ErrorCode": 2,
  "ErrorDescription": "sample string 3",
  "Meta": "sample string 4"
}

text/javascript

Sample:
{"Success":true,"Data":{"ID":1,"AccountID":2,"Username":"sample string 3","Email":"sample string 4","Status":0,"Auth":0,"PasswordInfo":{"Password":"sample string 1","MaxDenials":2,"ResetPeriod":3},"SSOInfo":{"PrivateUsername":"sample string 1"},"AccessTypes":[0,0,0],"VoucherID":5,"ResourceIDs":{"IPSec_L2TP":"3eb25d28-b932-4385-a875-d5fb492b96b1"},"ProvisioningID":"3eb1b285-c783-4df0-b829-3bd77d247b0c"},"ErrorCode":2,"ErrorDescription":"sample string 3","Meta":"sample string 4"}

application/xml, text/xml

Sample:
<PBNBReturnOfUserCA1DLPoZ xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/pbnb_models">
  <Data>
    <AccessTypes>
      <User.ClientAccessTypes>IPSec_L2TP</User.ClientAccessTypes>
      <User.ClientAccessTypes>IPSec_L2TP</User.ClientAccessTypes>
      <User.ClientAccessTypes>IPSec_L2TP</User.ClientAccessTypes>
    </AccessTypes>
    <AccountID>2</AccountID>
    <Auth>ServicePassword</Auth>
    <Email>sample string 4</Email>
    <ID>1</ID>
    <PasswordInfo>
      <MaxDenials>2</MaxDenials>
      <Password>sample string 1</Password>
      <ResetPeriod>3</ResetPeriod>
    </PasswordInfo>
    <ProvisioningID>3eb1b285-c783-4df0-b829-3bd77d247b0c</ProvisioningID>
    <ResourceIDs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfUser.ClientAccessTypesguidNQ1t37UU>
        <d3p1:Key>IPSec_L2TP</d3p1:Key>
        <d3p1:Value>3eb25d28-b932-4385-a875-d5fb492b96b1</d3p1:Value>
      </d3p1:KeyValueOfUser.ClientAccessTypesguidNQ1t37UU>
    </ResourceIDs>
    <SSOInfo>
      <PrivateUsername>sample string 1</PrivateUsername>
    </SSOInfo>
    <Status>Enabled</Status>
    <Username>sample string 3</Username>
    <VoucherID>5</VoucherID>
  </Data>
  <ErrorCode>2</ErrorCode>
  <ErrorDescription>sample string 3</ErrorDescription>
  <Meta>sample string 4</Meta>
  <Success>true</Success>
</PBNBReturnOfUserCA1DLPoZ>

application/bson

Sample:
�SuccessData~IDAccountIDUsernamesample string 3Emailsample string 4StatusAuthPasswordInfoDPasswordsample string 1MaxDenialsResetPeriodSSOInfo*PrivateUsernamesample string 1AccessTypes012VoucherIDResourceIDs&IPSec_L2TP(]�>2��C�u��I+��ProvisioningID���>���M�);�}${ErrorCodeErrorDescriptionsample string 3Metasample string 4