orchestrator
2021.10
false
Orchestrator API ガイド
- 基本情報
- 認証
- Swagger の定義
- Orchestrator API
- プラットフォーム管理 API
重要 :
このコンテンツの一部は機械翻訳によって処理されており、完全な翻訳を保証するものではありません。
新しいコンテンツの翻訳は、およそ 1 ～ 2 週間で公開されます。
組織およびロボット アカウント ID に基づいて、ロボット アカウントに関する情報を返します。
API エンドポイント
GET https://{yourDomain}/identity/api/RobotAccount/{partitionGlobalId}/{robotAccountId}
スコープ
次のスコープが必要です。
- PM.RobotAccount
- PM.RobotAccount.Read
要求ヘッダー
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
注:
To obtain the {access_token}, make sure to authenticate through one of the methods described here.
パス パラメーター
| パス パラメーター | データ型 | 説明 |
|---|---|---|
partitionGlobalId(必須) | 文字列 | 目的のグループを含む組織の ID です。 |
robotAccountID(必須) | 文字列 | 取得するロボット アカウントの ID です。 |
応答
200 OK
指定したロボット アカウントの情報 (名前、作成日時、アカウントが属するグループ ID など) が返されます。
要求の例
API 呼び出しの構築に必要な情報をすべて収集したとします。
{baseURL}はhttps://{yourDomain}/{organizationName}/{tenantName}/です。{access_token}は1234です (長さを考慮)。{partitionGlobalId}はmagic-7です。{robotAccountID}は33-abです。
呼び出しは以下のようになります (cURL)。
curl --location --request GET 'https://{yourDomain}/{organizationName}/{tenantName}/identity_/api/RobotAccount/magic-7/33-ab' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
curl --location --request GET 'https://{yourDomain}/{organizationName}/{tenantName}/identity_/api/RobotAccount/magic-7/33-ab' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
呼び出しが成功した場合、応答本文は次のようになります。
{
"id": "33-ab",
"name": "Bot3",
"displayName": "Bot3",
"creationTime": "2021-10-19T14:25:01.6574988",
"lastModificationTime": "2021-10-19T14:25:01.6574988",
"groupIds": [
"4d161738-7204", "ce684f6f-5af3"
]
}
{
"id": "33-ab",
"name": "Bot3",
"displayName": "Bot3",
"creationTime": "2021-10-19T14:25:01.6574988",
"lastModificationTime": "2021-10-19T14:25:01.6574988",
"groupIds": [
"4d161738-7204", "ce684f6f-5af3"
]
}