[预览] 更新用户

更新有关指定本地用户的信息。

API 端点

PUT https://{yourDomain}/identity/api/User/{userId}

作用域

需要以下作用域：

• PM.User
• PM.User.Write

请求标头

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

注意：如要获取 {access_token}，请确保通过此处描述的其中一种方法进行身份验证。

路径参数

参数	数据类型	描述
userId (必填)	字符串	要更新的用户 ID。

请求正文

请求正文包含要更新的用户信息，例如姓名、电子邮件或组成员身份。

{
  "name": "string",
  "surname": "string",
  "email": "[e-mail]",
  "isActive": true,
  "password": "string",
  "groupIDsToAdd": [
    "string"
  ],
  "groupIDsToRemove": [
    "string"
  ],
  "bypassBasicAuthRestriction": true,
  "invitationAccepted": true
}

响应

200 OK

系统将使用您提供的信息更新自定义组。

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（出于长度考虑）。
• 您希望更新用户 ID her-1909 的信息和成员资格。

调用应如下所示 (cURL)：

curl --location --request PUT 'https://{yourDomain}/{organizationName}/{tenantName}/identity_/api/User/her-1909' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
--data-raw '{
    "name": "Hermione",
    "surname": "Granger-Weasley",
    "email": "[e-mail]",
    "groupIDsToAdd": [
        "gryff-01",
        "alumni-02",
        "teachers-03"
    ],
    "groupIDsToRemove": [],
    "bypassBasicAuthRestriction": false
}'

以下是成功调用的响应：

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