Orchestrator API ガイド

デリバリー:

Automation Cloud Automation Cloud Public Sector Automation Suite Standalone

最終更新日時 2024年12月9日

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

組織 ID に基づいて、組織から複数のロボットアカウントを削除します。

API エンドポイント

DELETE https://{yourDomain}/identity/api/RobotAccount/{partitionGlobalId}

スコープ

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

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} を取得するには、必ずこちらで説明するいずれかの方法で認証を行ってください。

パスパラメーター

パスパラメーター	データ型	説明
`partitionGlobalId` (必須)	文字列	ロボットアカウントを取得する対象の組織の ID です。

要求本文

要求本文には、組織から一括削除するロボットアカウント ID のリストが含まれます。

{
     "robotAccountIDs": [
          "string",
          "string"
     ]
}{
     "robotAccountIDs": [
          "string",
          "string"
     ]
}

応答

200 OK

指定したロボットアカウントが組織から削除されます。

要求の例

API 呼び出しの構築に必要な情報をすべて収集したとします。

{baseURL} は https://{yourDomain}/{organizationName}/{tenantName}/ です。
{access_token} は 1234 です (長さを考慮)。
{partitionGlobalId} は magic-7 です。
削除するロボットアカウントの ID は次のとおりです。
- Bot1: 11-xy
- Bot2: 22-tz

呼び出しは以下のようになります (cURL)。

curl --location --request DELETE 'https://{yourDomain}/{organizationName}/{tenantName}/identity_/api/RobotAccount/magic-7' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
--data-raw '{
     "robotAccountIDs": [
          "11-xy",
          "22-tz"
     ]
}'curl --location --request DELETE 'https://{yourDomain}/{organizationName}/{tenantName}/identity_/api/RobotAccount/magic-7' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
--data-raw '{
     "robotAccountIDs": [
          "11-xy",
          "22-tz"
     ]
}'