Orchestrator API 指南

适用平台：

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

创建新的机器人帐户

在指定的组织 ID 中创建新的机器人帐户，并将其分配给指定的组。

API 端点

POST https://{yourDomain}/{organizationName}/identity/api/RobotAccount

作用域

需要以下作用域：

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}，请确保通过此处描述的其中一种方法进行身份验证。

请求正文

请求正文包含要向其添加组的组织 ID，并可选择是否要包含您希望添加其为新组的成员的用户。

{
  "partitionGlobalId": "string",
  "id": "string",
  "name": "string",
  "groupIDsToAdd": [
    "string", "string"
  ]
}{
  "partitionGlobalId": "string",
  "id": "string",
  "name": "string",
  "groupIDsToAdd": [
    "string", "string"
  ]
}

响应

201 Successful

系统将在指定的组织中创建自定义组，并提供 ID。

请求示例

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

您的 {baseURL} 为：https://{yourDomain}/{organizationName}/{tenantName}/
您的 {access_token} 为：1234（出于长度考虑）。
{partitionGlobalId} 为：magic-7
您希望为组命名："Gryffindors"
您想要将用户 Ron、Harry 和 Hermione 添加到组中。这些用户拥有以下用户 ID：
- Ron 用户标识符：ron-0103
- Harry 用户标识符：har-3107
- Hermione 用户标识符：her-1909

调用应如下所示 (cURL)：

curl --location --request POST 'https://{yourDomain}/{organizationName}/{tenantName}/identity_/api/Group' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
--data-raw '{
    "name": "Roby",
    "displayName": "Roby",
    "partitionGlobalId": "magic-7",
    "groupIDsToAdd": [
        "gryff-01"
    ],
    "groupIDsToRemove": []
}'curl --location --request POST 'https://{yourDomain}/{organizationName}/{tenantName}/identity_/api/Group' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
--data-raw '{
    "name": "Roby",
    "displayName": "Roby",
    "partitionGlobalId": "magic-7",
    "groupIDsToAdd": [
        "gryff-01"
    ],
    "groupIDsToRemove": []
}'

以下是成功调用的响应：

{
    "id": "rb-12",
    "name": "Roby",
    "displayName": "Roby",
    "creationTime": "2021-10-20T15:20:29.1302044Z",
    "lastLoginTime": null,
    "groupIds": ["gryff-01"]
}{
    "id": "rb-12",
    "name": "Roby",
    "displayName": "Roby",
    "creationTime": "2021-10-20T15:20:29.1302044Z",
    "lastLoginTime": null,
    "groupIds": ["gryff-01"]
}