> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API ポリシー

> どの呼び出し元がどの PlayFab API を使用できるかを制御する、タイトルの API アクセス ポリシーを読み取り、更新します。

タイトルの API アクセス ポリシーを読み取り、更新します。API アクセス ポリシーは、どの呼び出し元がどの PlayFab API を使用できるかを
制御するステートメントです。ポリシーが誤っていると、すべてのプレイヤーがタイトルから締め出される可能性があります。タイトルに対する
**Admin** 権限が必要です。
[PlayFab 認証のしくみ](https://docs.xbox.com/ja-jp/tools/xbox-cli/authentication.md#how-playfab-authentication-works)を参照してください。

| コマンド | PlayFab API パス | 説明 |
| - | - | - |
| `playfab api-policy get` | `/Admin/GetPolicy` | ポリシーのステートメントとバージョンを取得します。 |
| `playfab api-policy set` | `/Admin/UpdatePolicy` | ポリシーにステートメントを追加するか、ポリシーを置き換えます。 |

`api-policy` コマンドは `--output table` を受け付けません。

| オプション | コマンド | 必須 | 説明 |
| - | - | - | - |
| `--policy-name` | `get`、`set` | いいえ | ポリシー。既定値は `ApiPolicy` です。 |
| `--statements` | `set` | 2 つのうちいずれか | インラインの JSON 配列として指定するステートメント。 |
| `--statements-file` | `set` | 2 つのうちいずれか | ステートメントを JSON 配列として格納したファイル。 |
| `--policy-version` | `set` | はい | `get` が返すポリシーの現在のバージョン。その後ポリシーが変更されている場合、PlayFab は更新を拒否します。 |
| `--overwrite` | `set` | いいえ | ポリシー内のステートメントに追加するのではなく、すべてのステートメントを置き換えます。[ポリシーを置き換える](#replace-the-policy)を参照してください。 |

## ステートメントを追加する

現在のポリシーとそのバージョンを読み取ります。

```bash theme={null}
xbox --playfab-title-id ABC123 playfab api-policy get
```

追加するステートメントをファイルに記述します。次の `policy.json` は、すべての呼び出し元に対して Server API の
`DeleteCharacterFromUser` を拒否します。

```json theme={null}
[
  {
    "Resource": "pfrn:api--/Server/DeleteCharacterFromUser",
    "Action": "*",
    "Effect": "Deny",
    "Principal": "*",
    "Comment": "Disable server character delete"
  }
]
```

* `Resource` は、`pfrn:api--` と API パスを組み合わせたもの、またはすべての API を表す `pfrn:api--*` です。
* `Action` は `*` です。PlayFab が受け付ける値はこれだけです。
* `Effect` は `Allow` または `Deny` です。
* `Principal` は、すべての呼び出し元と一致させる場合は `*` です。
* `Comment` は、独自の記録用の省略可能なテキストです。
* `ApiConditions` は省略可能で、`{ "HasSignatureOrEncryption": "True" }` などの条件を設定します。
  この条件には `Any`、`True`、または `False` を指定します。

フィールド名の大文字と小文字は区別されません。スペルを誤った `ApiConditions` など、認識されないフィールドは
エラーになります。そのフィールドを無視すると、ステートメントで許可される範囲が広がる可能性があるためです。
PlayFab の [API アクセス ポリシー](https://learn.microsoft.com/gaming/playfab/api-references/api-access-policy)の
ページでは、各フィールドについて説明し、すべての API を許可する既定のポリシーを示しています。

次に、`get` が返したバージョンを渡して、ステートメントを追加します。

```bash theme={null}
xbox --playfab-title-id ABC123 playfab api-policy set --policy-version 3 --statements-file policy.json
```

## ポリシーを置き換える

> [!CAUTION]
>
> `--overwrite` はポリシー全体を渡したステートメントで置き換え、省略したすべてのステートメントを
> 破棄します。CLI は以前のポリシーを復元できないため、最初に `get` の出力を
> 保存してください。

`--overwrite` には、`--confirm` と、同じコマンドで `--playfab-title-id` によって指定されたタイトルが
必要です。`XBOX_PLAYFAB_TITLE_ID` または保存されたコンテキストから取得したタイトルは、`--confirm` を指定した場合でも
拒否され、代わりに実行するコマンドが出力されます。

```text theme={null}
$ xbox playfab api-policy set --policy-version 3 --statements-file policy.json --overwrite --confirm
Using --playfab-title-id ABC123 from saved context.
'/Admin/UpdatePolicy' with --overwrite acts on playfab-title-id ABC123, which comes from saved context.
The target of a destructive operation must be named on the command line. To proceed, run:
  xbox --playfab-title-id ABC123 playfab api-policy set --policy-version 3 --statements-file policy.json --overwrite --confirm
```


## Related topics

- [API ポリシーの検証](https://docs.xbox.com/ja-jp/services/playfab/api-references/rest/admin/authentication/validate-api-policy.md)
- [Economy v2 の設定の概要](https://docs.xbox.com/ja-jp/services/playfab/economy-monetization/economy-v2/settings.md)
- [Player Encryption サービス](https://docs.xbox.com/ja-jp/services/playfab/identity/player-identity/encryption/player-encryption-services.md)
- [API アクセス ポリシー](https://docs.xbox.com/ja-jp/services/playfab/api-references/api-access-policy.md)
- [Game Manager の API アクセス ポリシー](https://docs.xbox.com/ja-jp/services/playfab/live-service-management/gamemanager/api-access-page-doc.md)
