CLI edgeコマンド

edge apikeyコマンド

Version:

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

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

Sitecore CLIのExperience Edgeプラグインは、Experience EdgeのAPIキーの管理に役立つedge apikeyコマンドを提供します。

使用法とオプション

edge apikeyコマンドは、次のように使用できます。

dotnet sitecore edge apikey [subcommand] [options]

サブコマンドやオプションを指定せずにコマンドを使用すると、現在選択されているテナントのアクティブなAPIキーの一覧が返されます。例えば：

dotnet sitecore edge apikey

edge apikeyコマンドでは、次のオプションを使用できます。

オプション	形容
--token	Experience Edge APIキー値。
--hash	Experience Edge APIキーのハッシュ。 APIキーに関する情報をJSON形式で返します。
--pageSize	1つのチャンク/ページで返すAPIキーの数。デフォルト: 20
--pageNumber	結果に複数のページが含まれている場合に返されるページ番号。デフォルト: 1
--all, --showAll	指定した場合、キーのリストには失効したキーが含まれます。取り消されたAPIキーには、REVOKEDインジケーターが表示されます。
--env, --environment	ターゲットとするExperience Edge環境を指定します。取り得る値: preprod, prod デフォルト： prod
-?、-h、--help	コマンドに関する開発者向けヘルプと使用情報を表示します。

たとえば、現在のテナントの5つのAPIキー (取り消されたキーを含む) の2ページ目を表示するには、次のコマンドを実行します。

dotnet sitecore edge apikey --pageSize 5 --pageNumber 2 --all

APIキーに関する詳細情報を取得するには、次のコマンドを実行します。

dotnet sitecore edge apikey --hash <your-api-key-hash>

このコマンドは、APIキーに関するJSON形式の情報を表示します。

{
  "Hash": "XXXXX",
  "IsRevoked": <false|true>,
  "Label": "<apikey-label>",
  "Scopes": [
    "audience-preview",
    "content-#everything#"
  ],
  "CreatedBy": "<user>",
  "Created": "<created-date>"
}

メモ

日付は現地時間で表示されます。

サブコマンド

次のサブコマンドを使用できます。

create - 新しいExperience Edge APIキーを作成します。
revoke - Experience Edge APIキーを取り消します。

createサブコマンド

createサブコマンドは、指定されたオプションに基づいて新しいExperience Edge APIキーを作成します。例えば：

dotnet sitecore edge apikey create -l Main

このコマンドは、新しく作成されたAPIキーを出力します。

大事な

Experience Edgeは、APIキーをプレーンテキストで保存しません。したがって、出力からAPIキーをコピーして安全に保管することが重要です。

createサブコマンドでは、次のオプションを使用できます。

オプション	形容
-l, --label	必須。 Experience Edge APIキーラベル。
-s, --scopes	Experience Edge APIキーのスコープ。デフォルト： audience-delivery content-#everything#
-by, --createdBy	APIキーの作成者として割り当てるユーザー。デフォルト: 現在ログインしているユーザー。
--env, --environment	ターゲットとするExperience Edge環境を指定します。取り得る値: preprod, prod デフォルト： prod
-?、-h、--help	コマンドに関する開発者のヘルプと使用情報を表示します。

revokeサブコマンド

revokeサブコマンドは、Experience Edge APIキーを非アクティブ化して、使用されないようにします。例えば：

dotnet sitecore edge apikey revoke --hash <your-api-key-hash>

revokeサブコマンドでは、次のオプションを使用できます。

オプション	形容
--token	Experience Edge APIキー値。
--hash	Experience Edge APIキーのハッシュ。
--env, --environment	ターゲットとするExperience Edge環境を指定します。取り得る値: preprod, prod デフォルト： prod
-?、-h、--help	コマンドに関する開発者向けヘルプと使用情報を表示します。

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