PATCH v1/core/Accounts/{accId}/users/{usrId}?expand={expand}

Send partial User documents to the API and update the local User with that. This will only update Username, PasswordInfo and AccessTypes.

Request Information

Parameters

Name	Description	Additional information
accId		Define this parameter in the request URI.
usrId		Define this parameter in the request URI.
user		Define this parameter in the request body.
expand	optinal query string provided parameter to return resourceIDs	Define this parameter in the request URI.

Request body formats

application/json, text/json, text/javascript

Sample:

{}

application/xml, text/xml

Sample:

<DeltaOfUserCA1DLPoZ xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/pbnb_delta" />

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'Delta`1'.

application/bson

Sample:

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": "9b8dc254-443b-40bd-a545-2cd4b8c875e8"
    },
    "ProvisioningID": "7fe36b15-d4a9-4bf9-9034-54b76e378823"
  },
  "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":"9b8dc254-443b-40bd-a545-2cd4b8c875e8"},"ProvisioningID":"7fe36b15-d4a9-4bf9-9034-54b76e378823"},"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>7fe36b15-d4a9-4bf9-9034-54b76e378823</ProvisioningID>
    <ResourceIDs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfUser.ClientAccessTypesguidNQ1t37UU>
        <d3p1:Key>IPSec_L2TP</d3p1:Key>
        <d3p1:Value>9b8dc254-443b-40bd-a545-2cd4b8c875e8</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_L2TPT�;D�@�E,Ը�u�ProvisioningIDk����K�4T�n7�#ErrorCodeErrorDescriptionsample string 3Metasample string 4