---
title: "リストオール"
slug: "listall"
abstract: "すべてのAPIキーをリストアップする方法。"
---
# リストオール

*ListAll*エンドポイントはソリューション内のすべてのAPIキーを一覧にします。

相対ルート

/

HTTP Verb

GET

## クエリ文字列パラメータ

以下の表は利用可能なクエリ文字列パラメータを示しており、これらはすべて任意です。

名称

フォーマット

概要

scopes

文字列の配列

返される鍵のスコープを定義します。提供されない場合は、すべての鍵が返されます。

label

ストリング

キーをフィルタリングするラベルまたはその一部を定義します。この文字列を含むすべてのキーが返されます。提供されない場合は、すべてのキーが返されます。

pagesize

整数

ページあたりの結果数を定義します。 *Default*: 20。

pagenumber

整数

返すページ番号を定義します。 *Default*: 1 (結果の最初のページを返します)。

filterRevoked

ブール

これを trueに設定した場合、アクティブなAPIキーのみが返されます。 falseに設定した場合、キーがアクティブかどうかに関わらず返されます。 *Default*: false。

createdBy

ストリング

特定のユーザーが作成したAPIキーだけを返したい場合は、そのユーザー名をこのパラメータに割り当ててください。そうでなければ、誰が作成したかに関わらずクエリはキーを返します。

scopesパラメータはクエリ文字列内で複数回現れることがあり、以下の例に示されています。

https://edge.sitecorecloud.io/api/apikey/v1?scopes=audience-delivery&scopes=content-someid&label=mine&pagesize=50&pagenumber=3&filterRevoked=true&createdby=ADN

## 応答機関

レスポンスには各テナントのAPIキーのリストが含まれています。

{
 "totalCount": 2,
 "pageSize": 20,
 "currentPage": 1,
 "totalPages": 1,
 "hasNext": false,
 "hasPrevious": false,
 "keys": 
 {
 "TenantId": "Sitecore-tenant-id",
 "Hash": "example\_hash",
 "IsRevoked": false,
 "Label": "Example key",
 "Scopes": "scope1", "scope2",
 "CreatedBy": "ADN",
 "Created": "2023-01-23"
 },
 {
 "TenantId": "Sitecore-tenant-id",
 "Hash": "example\_hash\_2",
 "IsRevoked": false,
 "Label": "Example key 2",
 "Scopes": "scope3", "scope4",
 "CreatedBy": "ADN",
 "Created": "2023-01-23"
 }
 
}