Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 18 additions & 9 deletions docs/content-api/APIキー(APIの認証と権限管理).md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,13 @@ APIキーは**管理者権限を持つユーザーのみ、作成/編集/削

旧APIキー形式からの移行については[旧API(X-API-KEYなど)からの移行](/content-api/from-oldapikey-to-x-microcms-apikey)をご覧ください。

APIキーはプランごとに作成できる個数が異なります(Hobbyプランで1個、Teamプランで3個、Businessプランで10個)。
APIキーはプランごとに作成できる個数が異なります

* Hobbyプラン:1個
* Teamプラン:3個
* Businessプラン:10個
* Enterpriseプラン:20個

プランごとに利用できる機能については、[料金プランページ](https://microcms.io/pricing)をご覧ください。

APIキーの権限設定によっては、外部からの書き込み(WRITE系APIのリクエスト)が可能になったり、下書き状態のコンテンツが公開状態になってしまう可能性がございます。お取り扱いにはご注意ください。
Expand Down Expand Up @@ -112,11 +118,14 @@ APIキー作成モーダルの「マネジメントAPI(ベータ)」のタ
それぞれの項目の詳細については、下記のリンクからご確認ください。

* [コンテンツの取得 (一覧・詳細)](/management-api/get-list-contents-management)
* [コンテンツの作成者を変更](https://document.microcms.io/management-api/patch-contents-created-by)
* [コンテンツの作成者を変更](/management-api/patch-contents-created-by)
* [コンテンツの公開状態を変更](/management-api/patch-contents-status)
* [メディアの取得](/management-api/get-media-v2)
* [メディアのアップロード](/management-api/post-media)
* [メディアの削除](https://document.microcms.io/management-api/delete-media-v2)
* [メディアの削除](/management-api/delete-media-v2)
* [メンバーの取得 (一覧・詳細)](/management-api/get-member)
* [API情報の取得(一覧・詳細)](/management-api/get-api-info)
* [サービス情報の取得](/management-api/get-service)

APIキーによる権限設定のユースケース
===================
Expand All @@ -132,11 +141,11 @@ X-MICROCMS-API-KEYの権限管理を活用いただくことで、要件に応

* デフォルト権限ではGETのみを許可する。

![](https://images.microcms-assets.io/assets/d6af1616730544a596d299c20834f460/29d0da75949443f7aa94cdd2160799f3/x-microcms-api-key-8.png)
![](https://images.microcms-assets.io/assets/d6af1616730544a596d299c20834f460/f4efe4511c9d4e6a9eeebc52d6d03683/CleanShot%202025-08-21%20at%2014.31.26.png)

* お問い合わせなどの更新がされるコンテンツAPIのみPOSTなどの書き込み系の個別権限を設定する。このAPIキーはサーバーサイドで処理するなど取り扱いには注意をする。

![](https://images.microcms-assets.io/assets/d6af1616730544a596d299c20834f460/bdb4d218097d408b8e60789a0800a93e/x-microcms-api-key-9.png)
![](https://images.microcms-assets.io/assets/d6af1616730544a596d299c20834f460/14e90382c27b405189a0eb58d1a2480d/CleanShot%202025-08-21%20at%2014.32.23.png)

2. 公開・非公開コンテンツで使い分ける
--------------------
Expand All @@ -146,15 +155,15 @@ X-MICROCMS-API-KEYの権限管理を活用いただくことで、要件に応

* デフォルト権限は全て false

![](https://images.microcms-assets.io/assets/d6af1616730544a596d299c20834f460/1ad4a7e596674121878497ad9382e539/x-microcms-api-key-5.png)
![](https://images.microcms-assets.io/assets/d6af1616730544a596d299c20834f460/191281a6ff124b28b9aae1c3ad9d7297/CleanShot%202025-08-21%20at%2014.36.59.png)

* 公開する API は個別権限で GET のみ true

![](https://images.microcms-assets.io/assets/d6af1616730544a596d299c20834f460/a070f41f210f40b499497216f8acb1fd/x-microcms-api-key-6.png)
![](https://images.microcms-assets.io/assets/d6af1616730544a596d299c20834f460/e91d716b1f5b4fda9fac3c2716754d77/CleanShot%202025-08-21%20at%2014.37.47.png)

* プライベートな API は個別権限なし
* プライベートな API は個別権限を設定しない

![](https://images.microcms-assets.io/assets/d6af1616730544a596d299c20834f460/3aad4e9618fb4275887edce2c8f5d1fd/x-microcms-api-key-7.png)

という設定でキーを作ると、そのキーを直接クライアントに埋め込むことができるので API キーを隠すための中間サーバを作る手間を省くことができます。

3. マルチデバイスごとの設定
Expand Down