[プレビュー] ユーザー パスワードを更新する

指定したユーザーのパスワードを更新します。

API エンドポイント

https://{yourDomain}/identity_/api/User/{userId}/changepassword

スコープ

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

• PM.User
• PM.User.Write

要求ヘッダー

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

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

パス パラメーター

パス パラメーター	データ型	説明
userId (必須)	文字列	パスワードを更新する対象のユーザーの ID です。

要求本文

要求本文には、ユーザーの追加先の組織 ID が含まれます。任意で、ユーザーを割り当てて追加するグループも含まれます。

{
  "oldPassword": "string",
  "newPassword": "string"
}

応答

200 OK

指定した組織内にユーザーが作成され、ID が取得されます。

400 Bad Request

ユーザーを作成できませんでした。

{
    "errors": {
        "bypassBasicAuthRestriction": [
            "Unexpected character encountered while parsing value: h. Path 'bypassBasicAuthRestriction', line 17, position 35.",
            "Unexpected character encountered while parsing value: a. Path 'bypassBasicAuthRestriction', line 17, position 35."
        ]
    },
    "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
    "title": "One or more validation errors occurred.",
    "status": 400,
    "traceId": "00-aec3de9099a9934e9c31e26c19f5e0dd-8c0d3d5f476c7742-00"
}

要求の例

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

• {baseURL} は https://{yourDomain}/{organizationName}/{tenantName}/ です。
• {access_token} は 1234 です (長さを考慮)。
• {userId} は har-3107 です。

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

curl --location --request POST 'https://{yourDomain}/{organizationName}/{tenantName}/identity_/api/User/har-3107/changepassword' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
--data-raw '{
  "oldPassword": "al0h0m0ra-account",
  "newPassword": "patr0nu5"
}'

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

{
    "succeeded": true,
    "errors": []
}