Orchestrator API 指南

适用平台：

上次更新日期 2025年2月13日

更新机器人帐户

更新有关指定机器人帐户的信息。

API 端点

PUT https://{yourDomain}/{organizationName}/identity/api/Setting

作用域

需要以下作用域：

PM.RobotAccount
PM.RobotAccount.Write

请求标头

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

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

路径参数

参数	数据类型	描述
`robotAccountId` (必填)	字符串	要更新的机器人帐户 ID。

请求正文

请求正文包含机器人帐户所属的组织 ID，以及要更新的信息（例如组成员身份）。

{
  "partitionGlobalId": "string",
  "displayName": "string",
  "groupIDsToAdd": [
    "string"
  ],
  "groupIDsToRemove": [
    "string"
  ]
}{
  "partitionGlobalId": "string",
  "displayName": "string",
  "groupIDsToAdd": [
    "string"
  ],
  "groupIDsToRemove": [
    "string"
  ]
}

响应

200 OK

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

请求示例

假设您收集了构建 API 调用所需的所有信息。

您的 {baseURL} 为：https://{yourDomain}/{organizationName}/{tenantName}/
您的 {access_token} 为：1234（出于长度考虑）。
{partitionGlobalId} 为：magic-7
您希望将 ID 为 88-uv 的机器人帐户分配给组 ID alumni-02。

调用应如下所示 (cURL)：

curl --location --request PUT 'https://{yourDomain}/{organizationName}/{tenantName}/identity_/api/RobotAccount/88-uv' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
--data-raw '{
    "partitionGlobalId": "magic-7",
    "displayName": "Roby",
    "groupIDsToAdd": [
        "alumni-02"
    ],
    "groupIDsToRemove": []
}'curl --location --request PUT 'https://{yourDomain}/{organizationName}/{tenantName}/identity_/api/RobotAccount/88-uv' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
--data-raw '{
    "partitionGlobalId": "magic-7",
    "displayName": "Roby",
    "groupIDsToAdd": [
        "alumni-02"
    ],
    "groupIDsToRemove": []
}'

以下是成功调用的响应：

{
    "id": "88-uv",
    "name": "Roby",
    "displayName": "Roby",
    "creationTime": "2021-10-20T12:16:16.6492925",
    "lastLoginTime": null,
    "groupIds": [
        "alumni-02",
        "gryff-01"
    ]
}{
    "id": "88-uv",
    "name": "Roby",
    "displayName": "Roby",
    "creationTime": "2021-10-20T12:16:16.6492925",
    "lastLoginTime": null,
    "groupIds": [
        "alumni-02",
        "gryff-01"
    ]
}