[プレビュー] すべてのロボット アカウントを取得する

組織 ID に基づいて、組織のすべてのロボット アカウントのリストを返します。

API エンドポイント

https://{yourDomain}/identity_/api/Setting

スコープ

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

• PM.RobotAccount
• PM.RobotAccount.Read

要求ヘッダー

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

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

パス パラメーター

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

Query Parameters

クエリ パラメーター	データ型	説明
searchTerm (任意)	文字列	ロボット アカウントの検索に使用するキーです。
top (任意)	int32	上位 N 個のロボット アカウントを表示します。
skip (任意)	int32	上位 N 個のロボット アカウントをスキップします。
sortBy (任意)	int32	監査エントリの並べ替え条件として使用する DTO プロパティを指定します。 たとえば、name、creationTime、id などです。
sortOrder (任意)	int32	並べ替え順序を指定します。 たとえば、昇順 (asc) または降順 (desc) です。

応答

200 OK

クエリが実行されたロボット アカウントを返します。

要求の例

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

• {baseURL} は https://{yourDomain}/{organizationName}/{tenantName}/ です。
• {access_token} は 1234 です (長さを考慮)。
• {partitionGlobalId} は magic-7 です。

• 以下のクエリ パラメーターを設定します。

  • searchTerm = bot
  • top = 2。上位 2 件のエントリを表示します。
  • skip = 2。最初の 2 件のエントリをスキップします。
  • sortBy = name。エントリを名前で並べ替えます。
  • sortOrder = asc。エントリを最も古いものから最も新しいものの順に並べ替えます。

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

curl --location --request GET 'https://{yourDomain}/{organizationName}/{tenantName}/identity_/api/RobotAccount/magic-7?searchTerm=attended&top=2&skip=2&sortBy=name&sortOrder=asc' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'

監査エントリが正常に取得された場合、応答本文は次のようになります。

{
    "totalCount": 3,
    "results": [
        {
            "id": "55-ab",
            "name": "Bot5",
            "displayName": "Bot5",
            "creationTime": "2021-10-19T18:05:17.3465735",
            "lastLoginTime": null,
            "groupIds": [
                "group1",
                "group2",
                "group3"
            ]
        },
        {
            "id": "66-cd",
            "name": "Bot6",
            "displayName": "Bot6",
            "creationTime": "2021-10-19T18:06:00.3088553",
            "lastLoginTime": null,
            "groupIds": [
                "group1",
                "group3"
            ]
        },
        {
            "id": "77-ef",
            "name": "Bot7",
            "displayName": "Bot7",
            "creationTime": "2021-10-19T18:05:31.4736281",
            "lastLoginTime": null,
            "groupIds": [
                "group2"
            ]
        }
    ]
}