[プレビュー] ロボット アカウントを更新する

指定したロボット アカウントの情報を取得します。

API エンドポイント

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

スコープ

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

• PM.RobotAccount
• PM.RobotAccount.Write

要求ヘッダー

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

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

パス パラメーター

パラメーター	データ型	説明
robotAccountId (必須)	文字列	更新するロボット アカウントの ID です。

要求本文

要求本文には、ロボット アカウントが属する組織 ID と、更新する情報 (グループ メンバーシップなど) が含まれます。

{
  "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": []
}'

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

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