設定を更新する

ホストまたは組織の管理者は、このエンドポイントを使用して既存の設定を更新したり、指定した組織および/またはユーザー ID の新しい設定を作成したりします。

API エンドポイント

PUT /identity_/api/Setting

スコープ

次のスコープが必要です。

• PM.Setting
• PM.Setting.Write

要求ヘッダー

--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'

注: {access_token} を取得するには、必ずこちらで説明するいずれかの方法で認証を行ってください。

要求本文

要求本文には、組織 ID と更新する設定キーが含まれます。

{
  "settings": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "partitionGlobalId": "string",
  "userId": "string"
}

応答

200 OK

指定した情報で設定が更新されます。

要求の例

API 呼び出しの構築に必要な情報をすべて収集したとします。

• {baseURL} は https://{yourDomain}/{organizationName}/{tenantName}/ です。
• {access_token} は 1234 です (長さを考慮)。
• {partitionGlobalId} は 3fa85f64-5717-4562-b3fc-2c963f66afa6 です。
• 認証設定を更新して、ホスト管理者としてログインするようにします。

呼び出しは次の例のようになります (cURL)。

curl --location --request PUT 'https://{yourDomain}/{organizationName}/{tenantName}/identity_/api/Setting' \)\)
--header 'Authorization: Bearer 1234' \)\)
--header 'Content-Type: application/json'
--data-raw '
{
    "settings": [
        {
            "key": "Auth.Password.DefaultExpirationDays",
            "value": "0"
        },
        {
            "key": "Auth.Password.PasswordComplexity",
             "value": "{\"hasSpecialCharacter\":false,\"hasLowercase\":true,\"hasUppercase\":false,\"hasDigit\":true,\"Length\":\"10\"}" 
        },
        {
            "key": "Auth.Password.PreviousUseLimit",
            "value": "1"
        },
        {
            "key": "Auth.Password.ShouldChangePasswordAfterFirstLogin",
            "value": "true"
        },
        {
            "key": "Auth.UserLockOut.DefaultAccountLockoutSeconds",
            "value": "0"
        },
        {
            "key": "Auth.UserLockOut.IsEnabled",
            "value": "false"
        },
        {
            "key": "Auth.UserLockOut.MaxFailedAccessAttemptsBeforeLockout",
            "value": "2"
        }
    ],
    "partitionGlobalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}'

呼び出しが成功した場合、応答は次のようになります。

[
    {
        "id": 4,
        "key": "Auth.Password.DefaultExpirationDays",
        "value": "0",
        "partitionGlobalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "userId": null
    },
    {
        "id": 1,
        "key": "Auth.Password.PasswordComplexity",
        "value": "{\"HasDigit\":true,\"HasLowercase\":true,\"HasSpecialCharacter\":false,\"HasUppercase\":false,\"Length\":10,\"RegexComplexity\":{\"HasDigitRegex\":\"(?=.*\\\\d)\",\"HasLowercaseRegex\":\"(?=.*[a-z])\",\"HasSpecialCharacterRegex\":\"(?=.*[^a-zA-Z\\\\d])\",\"HasUppercaseRegex\":\"(?=.*[A-Z])\",\"LengthRegex\":\"{10,}\",\"Regex\":\"(?=.*\\\\d)(?=.*[a-z]).{10,}\"}}", 
        "partitionGlobalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "userId": null
    },
    {
        "id": 3,
        "key": "Auth.Password.PreviousUseLimit",
        "value": "1",
        "partitionGlobalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "userId": null
    },
    {
        "id": 2,
        "key": "Auth.Password.ShouldChangePasswordAfterFirstLogin",
        "value": "true",
        "partitionGlobalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "userId": null
    },
    {
        "id": 26,
        "key": "Auth.UserLockOut.DefaultAccountLockoutSeconds",
        "value": "0",
        "partitionGlobalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "userId": null
    },
    {
        "id": 27,
        "key": "Auth.UserLockOut.IsEnabled",
        "value": "false",
        "partitionGlobalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "userId": null
    },
    {
        "id": 28,
        "key": "Auth.UserLockOut.MaxFailedAccessAttemptsBeforeLockout",
        "value": "2",
        "partitionGlobalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "userId": null
    }
]