> ## 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.

# Stratégie d'API

> Lisez et mettez à jour la stratégie d'accès à l'API du titre, qui détermine quels appelants peuvent utiliser quelles API PlayFab.

Lisez et mettez à jour la stratégie d'accès à l'API du titre, c'est-à-dire les instructions qui déterminent quels appelants
peuvent utiliser quelles API PlayFab. Une stratégie incorrecte peut bloquer l'accès au titre pour tous les joueurs. Vous
avez besoin de l'autorisation **Admin** sur le titre ; consultez
[Fonctionnement de l'authentification PlayFab](https://docs.xbox.com/fr/tools/xbox-cli/authentication.md#how-playfab-authentication-works).

| Commande | Chemin de l'API PlayFab | Description |
| - | - | - |
| `playfab api-policy get` | `/Admin/GetPolicy` | Obtient les instructions et la version de la stratégie. |
| `playfab api-policy set` | `/Admin/UpdatePolicy` | Ajoute des instructions à la stratégie, ou la remplace. |

Les commandes `api-policy` n'acceptent pas `--output table`.

| Option | Commande | Obligatoire | Description |
| - | - | - | - |
| `--policy-name` | `get`, `set` | Non | La stratégie. Vaut `ApiPolicy` par défaut. |
| `--statements` | `set` | L'une des deux | Les instructions, sous forme de tableau JSON inline. |
| `--statements-file` | `set` | L'une des deux | Un fichier contenant les instructions sous forme de tableau JSON. |
| `--policy-version` | `set` | Oui | La version actuelle de la stratégie, que renvoie `get`. PlayFab refuse la mise à jour si la stratégie a changé depuis. |
| `--overwrite` | `set` | Non | Remplace toutes les instructions de la stratégie, au lieu de s'y ajouter. Consultez [Remplacer la stratégie](#replace-the-policy). |

## Ajouter des instructions

Lisez la stratégie actuelle et sa version :

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

Placez les instructions à ajouter dans un fichier. Ce fichier `policy.json` refuse `DeleteCharacterFromUser` de l'API Server
à tous les appelants :

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

* `Resource` est `pfrn:api--` suivi d'un chemin d'API, ou `pfrn:api--*` pour toutes les API.
* `Action` est `*`, la seule valeur qu'accepte PlayFab.
* `Effect` est `Allow` ou `Deny`.
* `Principal` est `*` pour correspondre à tous les appelants.
* `Comment` est un texte facultatif pour votre propre suivi.
* `ApiConditions` est facultatif et définit des conditions telles que
  `{ "HasSignatureOrEncryption": "True" }`, qui accepte `Any`, `True` ou `False`.

Les noms de champs ne respectent pas la casse. Un champ non reconnu, comme un `ApiConditions` mal orthographié,
est une erreur, car l'ignorer pourrait élargir ce qu'autorise l'instruction.
La page [Stratégie d'accès à l'API](https://learn.microsoft.com/gaming/playfab/api-references/api-access-policy) de PlayFab
décrit chaque champ et présente la stratégie par défaut, qui autorise toutes les API.

Ajoutez ensuite les instructions, en passant la version qu'a renvoyée `get` :

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

## Remplacer la stratégie

> [!CAUTION]
>
> `--overwrite` remplace l'intégralité de la stratégie par les instructions que vous passez, et supprime toutes les
> instructions que vous omettez. La CLI ne peut pas restaurer la stratégie précédente : enregistrez donc d'abord la sortie
> de `get`.

`--overwrite` a besoin de `--confirm`, ainsi que du titre indiqué avec `--playfab-title-id` dans la même
commande. Elle refuse un titre provenant de `XBOX_PLAYFAB_TITLE_ID` ou du contexte enregistré, même avec
`--confirm`, et affiche la commande à exécuter à la place :

```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

- [Valider la stratégie d'API](https://docs.xbox.com/fr/services/playfab/api-references/rest/admin/authentication/validate-api-policy.md)
- [Codes d'erreur globaux des méthodes d'API](https://docs.xbox.com/fr/services/playfab/api-references/global-api-method-error-codes.md)
- [Connexions chiffrées](https://docs.xbox.com/fr/services/playfab/identity/player-identity/encryption/encrypted-logins.md)
- [Notes de publication PlayFab 2017](https://docs.xbox.com/fr/services/playfab/release-notes/2017.md)
- [Stratégie d'accès aux API](https://docs.xbox.com/fr/services/playfab/api-references/api-access-policy.md)
