ListAll

Version:

日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

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"
    }
  ]
}

この記事を改善するための提案がある場合は、お知らせください!

ListAll

ルート パラメーター

応答

ルートパラメーター