[プレビュー] 新しいロボット アカウントを作成する

指定した組織 ID に新しいロボット アカウントを作成し、指定したグループに割り当てます。

API エンドポイント

POST https://{yourDomain}/identity_/api/RobotAccount

スコープ

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

• PM.RobotAccount
• PM.RobotAccount.Write

要求ヘッダー

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

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

要求本文

要求本文には、グループの追加先の組織 ID が含まれます。任意で、新しいグループのメンバーとして追加するユーザーも含まれます。

{
  "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 のユーザー ID: ron-0103
  • Harry のユーザー ID: har-3107
  • Hermione のユーザー ID: 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": []
}'

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

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