トークンAPI

リストすべて

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

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

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

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