ListAll

Current version: 4.2

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

相対ルート/
HTTP 動詞GET

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

次のパラメーターが必要です。

名前形式目的
scopes文字列の配列キーを返す必要があるスコープを定義します。指定しない場合は、すべてのキーが返されます。
label文字列キーを絞り込むためのラベルまたはラベルの一部を定義します。この文字列を含むすべてのキーが返されます。指定しない場合、すべてのキーが返されます。
pagesize整数ページごとに返されるキーの数を定義します。既定: 20
pagenumber整数返されるページ番号を定義します。既定: 1 (最初のページを返します)。

パラメーターを使用してクエリを実行するには、次の構造例を使用します。

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

注意

スコープ パラメーターは列挙可能です。クエリ文字列に複数回表示される場合があります。

応答

応答は、ページング メタデータと一緒に提供されるフィルターとページングの設定を満たす DeliveryApiKey の配列です。 ` { "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": "2020-12-02" }, { "TenantId": "Sitecore-tenant-id", "Hash": "example_hash_2", "IsRevoked": false, "Label": "Example key 2", "Scopes": ["scope3", "scope4"], "CreatedBy": "ADN", "Created": "2020-12-02" } ] }

Do you have some feedback for us?

If you have suggestions for improving this article,