Chilkat Online Tools

phpExt / DocuSign REST API / Update the password rules

Back to Collection Items

<?php

include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

$http = new CkHttp();

// Use this online tool to generate code from sample JSON: Generate Code to Create JSON

// The following JSON is sent in the request body.

// {
//   "passwordStrengthType": "sample string 1",
//   "passwordStrengthTypeMetadata": {
//     "options": [
//       {
//         "name": "sample string 1",
//         "minimumLength": "sample string 2",
//         "passwordIncludeUpperCase": "sample string 3",
//         "passwordIncludeLowerCase": "sample string 4",
//         "passwordIncludeDigit": "sample string 5",
//         "passwordIncludeSpecialCharacter": "sample string 6",
//         "passwordIncludeDigitOrSpecialCharacter": "sample string 7"
//       }
//     ]
//   },
//   "expirePassword": "sample string 2",
//   "expirePasswordDays": "sample string 3",
//   "expirePasswordDaysMetadata": {
//     "minimumDays": "sample string 1",
//     "maximumDays": "sample string 2"
//   },
//   "minimumPasswordLength": "sample string 4",
//   "minimumPasswordLengthMetadata": {
//     "minimumLength": "sample string 1",
//     "maximumLength": "sample string 2"
//   },
//   "minimumPasswordAgeDays": "sample string 5",
//   "minimumPasswordAgeDaysMetadata": {
//     "minimumAge": "sample string 1",
//     "maximumAge": "sample string 2"
//   },
//   "lockoutDurationType": "sample string 6",
//   "lockoutDurationTypeMetadata": {
//     "options": [
//       "sample string 1"
//     ]
//   },
//   "lockoutDurationMinutes": "sample string 7",
//   "lockoutDurationMinutesMetadata": {
//     "minimumMinutes": "sample string 1",
//     "maximumMinutes": "sample string 2"
//   },
//   "passwordIncludeUpperCase": "sample string 8",
//   "passwordIncludeLowerCase": "sample string 9",
//   "passwordIncludeDigit": "sample string 10",
//   "passwordIncludeSpecialCharacter": "sample string 11",
//   "passwordIncludeDigitOrSpecialCharacter": "sample string 12",
//   "questionsRequired": "sample string 13",
//   "questionsRequiredMetadata": {
//     "minimumQuestions": "sample string 1",
//     "maximumQuestions": "sample string 2"
//   }
// }

$json = new CkJsonObject();
$json->UpdateString('passwordStrengthType','sample string 1');
$json->UpdateString('passwordStrengthTypeMetadata.options[0].name','sample string 1');
$json->UpdateString('passwordStrengthTypeMetadata.options[0].minimumLength','sample string 2');
$json->UpdateString('passwordStrengthTypeMetadata.options[0].passwordIncludeUpperCase','sample string 3');
$json->UpdateString('passwordStrengthTypeMetadata.options[0].passwordIncludeLowerCase','sample string 4');
$json->UpdateString('passwordStrengthTypeMetadata.options[0].passwordIncludeDigit','sample string 5');
$json->UpdateString('passwordStrengthTypeMetadata.options[0].passwordIncludeSpecialCharacter','sample string 6');
$json->UpdateString('passwordStrengthTypeMetadata.options[0].passwordIncludeDigitOrSpecialCharacter','sample string 7');
$json->UpdateString('expirePassword','sample string 2');
$json->UpdateString('expirePasswordDays','sample string 3');
$json->UpdateString('expirePasswordDaysMetadata.minimumDays','sample string 1');
$json->UpdateString('expirePasswordDaysMetadata.maximumDays','sample string 2');
$json->UpdateString('minimumPasswordLength','sample string 4');
$json->UpdateString('minimumPasswordLengthMetadata.minimumLength','sample string 1');
$json->UpdateString('minimumPasswordLengthMetadata.maximumLength','sample string 2');
$json->UpdateString('minimumPasswordAgeDays','sample string 5');
$json->UpdateString('minimumPasswordAgeDaysMetadata.minimumAge','sample string 1');
$json->UpdateString('minimumPasswordAgeDaysMetadata.maximumAge','sample string 2');
$json->UpdateString('lockoutDurationType','sample string 6');
$json->UpdateString('lockoutDurationTypeMetadata.options[0]','sample string 1');
$json->UpdateString('lockoutDurationMinutes','sample string 7');
$json->UpdateString('lockoutDurationMinutesMetadata.minimumMinutes','sample string 1');
$json->UpdateString('lockoutDurationMinutesMetadata.maximumMinutes','sample string 2');
$json->UpdateString('passwordIncludeUpperCase','sample string 8');
$json->UpdateString('passwordIncludeLowerCase','sample string 9');
$json->UpdateString('passwordIncludeDigit','sample string 10');
$json->UpdateString('passwordIncludeSpecialCharacter','sample string 11');
$json->UpdateString('passwordIncludeDigitOrSpecialCharacter','sample string 12');
$json->UpdateString('questionsRequired','sample string 13');
$json->UpdateString('questionsRequiredMetadata.minimumQuestions','sample string 1');
$json->UpdateString('questionsRequiredMetadata.maximumQuestions','sample string 2');

// Adds the "Authorization: Bearer {{accessToken}}" header.
$http->put_AuthToken('{{accessToken}}');
$http->SetRequestHeader('Accept','application/json');

$sbRequestBody = new CkStringBuilder();
$json->EmitSb($sbRequestBody);

// resp is a CkHttpResponse
$resp = $http->PTextSb('PUT','https://domain.com/v2.1/accounts/{{accountId}}/settings/password_rules',$sbRequestBody,'utf-8','application/json',false,false);
if ($http->get_LastMethodSuccess() == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

print $resp->get_StatusCode() . "\n";
print $resp->bodyStr() . "\n";


?>

Curl Command

curl -X PUT
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
	-d '{
  "passwordStrengthType": "sample string 1",
  "passwordStrengthTypeMetadata": {
    "options": [
      {
        "name": "sample string 1",
        "minimumLength": "sample string 2",
        "passwordIncludeUpperCase": "sample string 3",
        "passwordIncludeLowerCase": "sample string 4",
        "passwordIncludeDigit": "sample string 5",
        "passwordIncludeSpecialCharacter": "sample string 6",
        "passwordIncludeDigitOrSpecialCharacter": "sample string 7"
      }
    ]
  },
  "expirePassword": "sample string 2",
  "expirePasswordDays": "sample string 3",
  "expirePasswordDaysMetadata": {
    "minimumDays": "sample string 1",
    "maximumDays": "sample string 2"
  },
  "minimumPasswordLength": "sample string 4",
  "minimumPasswordLengthMetadata": {
    "minimumLength": "sample string 1",
    "maximumLength": "sample string 2"
  },
  "minimumPasswordAgeDays": "sample string 5",
  "minimumPasswordAgeDaysMetadata": {
    "minimumAge": "sample string 1",
    "maximumAge": "sample string 2"
  },
  "lockoutDurationType": "sample string 6",
  "lockoutDurationTypeMetadata": {
    "options": [
      "sample string 1"
    ]
  },
  "lockoutDurationMinutes": "sample string 7",
  "lockoutDurationMinutesMetadata": {
    "minimumMinutes": "sample string 1",
    "maximumMinutes": "sample string 2"
  },
  "passwordIncludeUpperCase": "sample string 8",
  "passwordIncludeLowerCase": "sample string 9",
  "passwordIncludeDigit": "sample string 10",
  "passwordIncludeSpecialCharacter": "sample string 11",
  "passwordIncludeDigitOrSpecialCharacter": "sample string 12",
  "questionsRequired": "sample string 13",
  "questionsRequiredMetadata": {
    "minimumQuestions": "sample string 1",
    "maximumQuestions": "sample string 2"
  }
}'
https://domain.com/v2.1/accounts/{{accountId}}/settings/password_rules

Postman Collection Item JSON

{
  "name": "Update the password rules",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"passwordStrengthType\": \"sample string 1\",\n  \"passwordStrengthTypeMetadata\": {\n    \"options\": [\n      {\n        \"name\": \"sample string 1\",\n        \"minimumLength\": \"sample string 2\",\n        \"passwordIncludeUpperCase\": \"sample string 3\",\n        \"passwordIncludeLowerCase\": \"sample string 4\",\n        \"passwordIncludeDigit\": \"sample string 5\",\n        \"passwordIncludeSpecialCharacter\": \"sample string 6\",\n        \"passwordIncludeDigitOrSpecialCharacter\": \"sample string 7\"\n      }\n    ]\n  },\n  \"expirePassword\": \"sample string 2\",\n  \"expirePasswordDays\": \"sample string 3\",\n  \"expirePasswordDaysMetadata\": {\n    \"minimumDays\": \"sample string 1\",\n    \"maximumDays\": \"sample string 2\"\n  },\n  \"minimumPasswordLength\": \"sample string 4\",\n  \"minimumPasswordLengthMetadata\": {\n    \"minimumLength\": \"sample string 1\",\n    \"maximumLength\": \"sample string 2\"\n  },\n  \"minimumPasswordAgeDays\": \"sample string 5\",\n  \"minimumPasswordAgeDaysMetadata\": {\n    \"minimumAge\": \"sample string 1\",\n    \"maximumAge\": \"sample string 2\"\n  },\n  \"lockoutDurationType\": \"sample string 6\",\n  \"lockoutDurationTypeMetadata\": {\n    \"options\": [\n      \"sample string 1\"\n    ]\n  },\n  \"lockoutDurationMinutes\": \"sample string 7\",\n  \"lockoutDurationMinutesMetadata\": {\n    \"minimumMinutes\": \"sample string 1\",\n    \"maximumMinutes\": \"sample string 2\"\n  },\n  \"passwordIncludeUpperCase\": \"sample string 8\",\n  \"passwordIncludeLowerCase\": \"sample string 9\",\n  \"passwordIncludeDigit\": \"sample string 10\",\n  \"passwordIncludeSpecialCharacter\": \"sample string 11\",\n  \"passwordIncludeDigitOrSpecialCharacter\": \"sample string 12\",\n  \"questionsRequired\": \"sample string 13\",\n  \"questionsRequiredMetadata\": {\n    \"minimumQuestions\": \"sample string 1\",\n    \"maximumQuestions\": \"sample string 2\"\n  }\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/settings/password_rules",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "settings",
        "password_rules"
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}"
        }
      ]
    }
  },
  "response": [
  ]
}