---
title: "エッジapikeyコマンド"
slug: "the-edge-apikey-command"
abstract: "Experience Edge APIキー管理のためのSitecore CLI edge apikeyコマンドの参考文献です。"
---
# エッジapikeyコマンド

Sitecore CLIのExperience Edgeプラグインは、Experience Edgeのキー管理を助けるedge apikeyコマンドAPI提供しています。

## 用途とオプション

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サブコマンドは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

開発者のヘルプやコマンドの使用情報を表示します。