GET v1/core/Accounts/{accId}/users/paged?pageSize={pageSize}&pageNumber={pageNumber}&includeTotal={includeTotal}

List all the users in this account using a paged result set

Request Information

Parameters

Name	Description	Additional information
accId	The account ID	Define this parameter in the request URI.
pageSize	The number of results to return per page. Allowable values between 0 and 1000. The default value is 0. If an invalid value is supplied, 1000 will be used instead.	Define this parameter in the request URI.
pageNumber	The page number, starting from 0. The default value is 0. If an invalid value is supplied, 1000 will be used instead.	Define this parameter in the request URI.
includeTotal	Flag indicating whether to include the total row count. Default value is false.	Define this parameter in the request URI.

Response Information

A paged list of users

Response body formats

application/json, text/json

Sample:

{
  "Success": true,
  "Data": {
    "PreviousPage": 1,
    "CurrentPage": 1,
    "NextPage": 1,
    "PageSize": 2,
    "TotalCount": 1,
    "ResultSet": [
      {
        "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": "40f373cf-6fe9-4807-9dbd-eea52f3f3b3e"
        },
        "ProvisioningID": "e97f8d06-e8b9-4a21-9799-ca27a75efcd9"
      },
      {
        "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": "40f373cf-6fe9-4807-9dbd-eea52f3f3b3e"
        },
        "ProvisioningID": "e97f8d06-e8b9-4a21-9799-ca27a75efcd9"
      },
      {
        "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": "40f373cf-6fe9-4807-9dbd-eea52f3f3b3e"
        },
        "ProvisioningID": "e97f8d06-e8b9-4a21-9799-ca27a75efcd9"
      }
    ]
  },
  "ErrorCode": 2,
  "ErrorDescription": "sample string 3",
  "Meta": "sample string 4"
}

text/javascript

Sample:

{"Success":true,"Data":{"PreviousPage":1,"CurrentPage":1,"NextPage":1,"PageSize":2,"TotalCount":1,"ResultSet":[{"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":"40f373cf-6fe9-4807-9dbd-eea52f3f3b3e"},"ProvisioningID":"e97f8d06-e8b9-4a21-9799-ca27a75efcd9"},{"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":"40f373cf-6fe9-4807-9dbd-eea52f3f3b3e"},"ProvisioningID":"e97f8d06-e8b9-4a21-9799-ca27a75efcd9"},{"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":"40f373cf-6fe9-4807-9dbd-eea52f3f3b3e"},"ProvisioningID":"e97f8d06-e8b9-4a21-9799-ca27a75efcd9"}]},"ErrorCode":2,"ErrorDescription":"sample string 3","Meta":"sample string 4"}

application/xml, text/xml

Sample:

<PBNBReturnOfPagedListOfUserCA1DLPoZCA1DLPoZ xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/pbnb_models">
  <Data>
    <CurrentPage>1</CurrentPage>
    <NextPage>1</NextPage>
    <PageSize>2</PageSize>
    <PreviousPage>1</PreviousPage>
    <ResultSet>
      <User>
        <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>e97f8d06-e8b9-4a21-9799-ca27a75efcd9</ProvisioningID>
        <ResourceIDs xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfUser.ClientAccessTypesguidNQ1t37UU>
            <d5p1:Key>IPSec_L2TP</d5p1:Key>
            <d5p1:Value>40f373cf-6fe9-4807-9dbd-eea52f3f3b3e</d5p1:Value>
          </d5p1:KeyValueOfUser.ClientAccessTypesguidNQ1t37UU>
        </ResourceIDs>
        <SSOInfo>
          <PrivateUsername>sample string 1</PrivateUsername>
        </SSOInfo>
        <Status>Enabled</Status>
        <Username>sample string 3</Username>
        <VoucherID>5</VoucherID>
      </User>
      <User>
        <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>e97f8d06-e8b9-4a21-9799-ca27a75efcd9</ProvisioningID>
        <ResourceIDs xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfUser.ClientAccessTypesguidNQ1t37UU>
            <d5p1:Key>IPSec_L2TP</d5p1:Key>
            <d5p1:Value>40f373cf-6fe9-4807-9dbd-eea52f3f3b3e</d5p1:Value>
          </d5p1:KeyValueOfUser.ClientAccessTypesguidNQ1t37UU>
        </ResourceIDs>
        <SSOInfo>
          <PrivateUsername>sample string 1</PrivateUsername>
        </SSOInfo>
        <Status>Enabled</Status>
        <Username>sample string 3</Username>
        <VoucherID>5</VoucherID>
      </User>
      <User>
        <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>e97f8d06-e8b9-4a21-9799-ca27a75efcd9</ProvisioningID>
        <ResourceIDs xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfUser.ClientAccessTypesguidNQ1t37UU>
            <d5p1:Key>IPSec_L2TP</d5p1:Key>
            <d5p1:Value>40f373cf-6fe9-4807-9dbd-eea52f3f3b3e</d5p1:Value>
          </d5p1:KeyValueOfUser.ClientAccessTypesguidNQ1t37UU>
        </ResourceIDs>
        <SSOInfo>
          <PrivateUsername>sample string 1</PrivateUsername>
        </SSOInfo>
        <Status>Enabled</Status>
        <Username>sample string 3</Username>
        <VoucherID>5</VoucherID>
      </User>
    </ResultSet>
    <TotalCount>1</TotalCount>
  </Data>
  <ErrorCode>2</ErrorCode>
  <ErrorDescription>sample string 3</ErrorDescription>
  <Meta>sample string 4</Meta>
  <Success>true</Success>
</PBNBReturnOfPagedListOfUserCA1DLPoZCA1DLPoZ>

application/bson

Sample:

KSuccessData�PreviousPageCurrentPageNextPagePageSizeTotalCountResultSet�0~IDAccountIDUsernamesample string 3Emailsample string 4StatusAuthPasswordInfoDPasswordsample string 1MaxDenialsResetPeriodSSOInfo*PrivateUsernamesample string 1AccessTypes012VoucherIDResourceIDs&IPSec_L2TP�s�@�oH���/?;>ProvisioningID���!J���'�^��1~IDAccountIDUsernamesample string 3Emailsample string 4StatusAuthPasswordInfoDPasswordsample string 1MaxDenialsResetPeriodSSOInfo*PrivateUsernamesample string 1AccessTypes012VoucherIDResourceIDs&IPSec_L2TP�s�@�oH���/?;>ProvisioningID���!J���'�^��2~IDAccountIDUsernamesample string 3Emailsample string 4StatusAuthPasswordInfoDPasswordsample string 1MaxDenialsResetPeriodSSOInfo*PrivateUsernamesample string 1AccessTypes012VoucherIDResourceIDs&IPSec_L2TP�s�@�oH���/?;>ProvisioningID���!J���'�^��ErrorCodeErrorDescriptionsample string 3Metasample string 4