翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
# Grafana HTTP API での認証に対する API キーの使用
Grafana API にアクセスする 1 つの方法は、*API キー*を使用することです。これは *API トークン*とも呼ばれます。PPI キーを作成するには、次のいずれかの手順に従います。API キーは、作成時に指定した期間の有効で、有効期間は最大 30 日です。
**Topics**
+ [ワークスペースでの Grafana API で使用する Grafana API キーの作成 (コンソール)](#API_key_console)
+ [を使用した Amazon Managed Grafana ワークスペース API キーの作成 AWS CLI](#API_key_CLI)
**注記**
バージョン 9 以降では、API キーの代わりにサービスアカウントの使用をお勧めします。サービスアカウントは、Grafana API とやり取りするアプリケーションを認証するための主な方法として API に代わるものです。Grafana Labs は今後のリリースで API キーが削除されることを発表しました。
API キーを作成するとき、キーの*ロール*を指定します。ロールによりキーのユーザーが持つ管理能力レベルが決定します。
次の表は、管理、エディタ、表示者の各ロールに付与されたアクセス許可を示しています。最初の表は全般的な組織のアクセス許可を示しています。このテーブルでは、**[フル]** はアクセス許可を表示、編集、追加、削除する機能を意味します。**Explore** 列には、ロールが *Explore* ビューを使用できるかどうかが表示されます。**その他の**アクセス許可列には、ロールにユーザー、チーム、プラグイン、組織の設定を管理するアクセス許可があるかどうかが示されます。
| ロール | ダッシュボード | プレイリスト | フォルダ | Explore | データソース | その他のアクセス許可 |
| --- | --- | --- | --- | --- | --- | --- |
| **表示者** | 表示 | 表示 | いいえ | なし | なし | いいえ |
| **[Editor]** (エディタ) | Full | Full | Full | あり | なし | いいえ |
| **Admin** | Full | Full | Full | あり | Full | Full |
次の表は、設定可能な追加のダッシュボードレベルおよびフォルダレベルのアクセス許可を示しています。これらは、管理、エディタ、表示者のロールとは異なります。
| ロール | ダッシュボード | フォルダ | 許可の変更 |
| --- | --- | --- | --- |
| **表示** | 表示 | 表示 | いいえ |
| **編集** | 作成、編集 | 表示 | いいえ |
| **Admin** | 作成、編集、削除 | 作成、編集、削除 | あり |
**注記**
より多い権限を持つ一般的なルールが存在する場合、より低い権限レベルの範囲にある権限は効果を持ちません。例えば、あるユーザーに組織 **[エディタ]** ロールを付与してから、そのユーザーにダッシュボードの **[表示]** アクセス許可のみを割り当てると、ユーザーは **[エディタ]** ロールを持つため完全な **[編集]** アクセス権限を持ち、より制限の厳しい **[表示]** アクセス許可は効果を持ちません。
## ワークスペースでの Grafana API で使用する Grafana API キーの作成 (コンソール)
**注記**
Grafana バージョン 10 以降と互換性のある Amazon Managed Grafana ワークスペースでは、ワークスペースで API キーを作成する機能が削除されました。ワークスペースが Grafana バージョン 10 のワークスペースである場合は、 AWS CLI または API を介してのみ API キーを作成できます。
Grafana Labs は今後のリリースで API キーが削除されることを発生しました。代わりにサービスアカウントの使用をお勧めします。
**ワークスペースコンソールでの Grafana API で使用する Grafana API キーの作成方法**
1. Amazon Managed Grafana コンソール ([https://console.aws.amazon.com/grafana/](https://console.aws.amazon.com/grafana/home/)) を開きます。
1. ページの左上隅にあるメニューアイコンを選択し、**[すべてのワークスペース]** を選択します。
1. Amazon Managed Grafana ワークスペースの名前を選択します。
1. ワークスペースの詳細ページで、**[Grafana ワークスペース URL]** の下に表示される URL を選択します。
1. Grafana コンソールのサイドメニューで、カーソルを **[設定]** (歯車) アイコンに置き、**[API キー]** を選択します。
1. **[新しい API キー]** を選択します。
1. キーの一意の名前を入力します。
1. **[ロール]** では、キーに付与するアクセスレベルを選択します。**[管理]** を選択すると、このキーを持つユーザーが、最も広範で強力な管理レベルで API を使用できるようになります。**[エディタ]** または **[表示者]** を選択して、それらのパワーレベルにキーのユーザーを制限します。詳細については、前のテーブルを参照してください。
1. **[有効期限]** では、キーの有効期間を指定します。最大は 30 日 (1 か月) です。数字と文字を入力します。有効な文字は、秒の **[s]**、分の **[m]**、時間の **[h]**、日の **[d]**、週の **[w]**、月の **[M]** です。例えば、**[12h]** は 12 時間、**[1M]** は 1 か月 (30 日) です。
短時間 (数時間以下など) に設定することを強くお勧めします。これにより、長期間有効な API キーを持つ場合と比較してリスクが大幅に軽減されます。
1. **[Add]** (追加) を選択します。
1. (オプション) API キーの作成は、Terraform を使用した [[API キーの作成]](Grafana-API-Authentication.md) API で自動化できます。Terraform を使用した API キー作成の自動化の詳細については、[[Terraform を使用した Grafana API キーの作成]](https://aws-observability.github.io/observability-best-practices/recipes/recipes/amg-automation-tf/) を参照してください。
## を使用した Amazon Managed Grafana ワークスペース API キーの作成 AWS CLI
** AWS CLIを使用した Amazon Managed Grafana ワークスペース API キーの作成方法**
次の例では、*key\$1name*、*key\$1role*、*seconds\$1to\$1live*、*Workspace\$1id* を独自の情報に置き換えます。key-name、key-role、secon-to-live の形式については、 API ガイド「[https://docs.aws.amazon.com/grafana/latest/APIReference/API_CreateWorkspaceApiKey.html](https://docs.aws.amazon.com/grafana/latest/APIReference/API_CreateWorkspaceApiKey.html)」を参照してください。
```
aws grafana create-workspace-api-key --key-name "key_name" --key-role "key_role" --seconds-to-live seconds_to_live --workspace-id "workspace_id"
```
CLI レスポンスの例を次に示します。
![\[\]](http://docs.aws.amazon.com/ja_jp/grafana/latest/userguide/images/APICLI.png)
ワークスペースの *Workspace\$1id* は、次のコマンドを実行して確認できます。
```
aws grafana list-workspaces
```