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

# Directiva de API

> Lee y actualiza la directiva de acceso a la API del título, que controla qué autores de llamadas pueden usar qué API de PlayFab.

Lee y actualiza la directiva de acceso a la API del título, las instrucciones que controlan qué autores de llamadas
pueden usar qué API de PlayFab. Una directiva incorrecta puede impedir el acceso al título a todos los jugadores.
Necesitas el permiso **Admin** en el título; consulta
[Cómo funciona la autenticación de PlayFab](https://docs.xbox.com/es/tools/xbox-cli/authentication.md#how-playfab-authentication-works).

| Comando | Ruta de la API de PlayFab | Descripción |
| - | - | - |
| `playfab api-policy get` | `/Admin/GetPolicy` | Obtiene las instrucciones y la versión de la directiva. |
| `playfab api-policy set` | `/Admin/UpdatePolicy` | Agrega instrucciones a la directiva o la reemplaza. |

Los comandos `api-policy` no aceptan `--output table`.

| Opción | Comando | Obligatorio | Descripción |
| - | - | - | - |
| `--policy-name` | `get`, `set` | No | La directiva. El valor predeterminado es `ApiPolicy`. |
| `--statements` | `set` | Una de estas dos | Las instrucciones, como una matriz JSON insertada. |
| `--statements-file` | `set` | Una de estas dos | Un archivo que contiene las instrucciones como una matriz JSON. |
| `--policy-version` | `set` | Sí | La versión actual de la directiva, que devuelve `get`. PlayFab rechaza la actualización si la directiva ha cambiado desde entonces. |
| `--overwrite` | `set` | No | Reemplaza todas las instrucciones de la directiva, en lugar de agregarlas. Consulta [Reemplazar la directiva](#replace-the-policy). |

## Agregar instrucciones

Lee la directiva actual y su versión:

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

Coloca las instrucciones que quieras agregar en un archivo. Este `policy.json` deniega
`DeleteCharacterFromUser` de la API de servidor a todos los autores de llamadas:

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

* `Resource` es `pfrn:api--` seguido de una ruta de API, o `pfrn:api--*` para todas las API.
* `Action` es `*`, el único valor que acepta PlayFab.
* `Effect` es `Allow` o `Deny`.
* `Principal` es `*` para que coincida con todos los autores de llamadas.
* `Comment` es un texto opcional para tus propios registros.
* `ApiConditions` es opcional y establece condiciones como
  `{ "HasSignatureOrEncryption": "True" }`, que acepta `Any`, `True` o `False`.

Los nombres de campo no distinguen mayúsculas de minúsculas. Un campo no reconocido, como un
`ApiConditions` mal escrito, es un error, porque descartarlo podría ampliar lo que permite la instrucción.
La página [Directiva de acceso a la API](https://learn.microsoft.com/gaming/playfab/api-references/api-access-policy) de PlayFab
describe cada campo y muestra la directiva predeterminada, que permite todas las API.

Después, agrega las instrucciones y pasa la versión que devolvió `get`:

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

## Reemplazar la directiva

> [!CAUTION]
>
> `--overwrite` reemplaza toda la directiva por las instrucciones que pasas y descarta todas
> las instrucciones que omites. La CLI no puede restaurar la directiva anterior, así que guarda primero la salida
> de `get`.

`--overwrite` necesita `--confirm` y que el título se indique con `--playfab-title-id` en el mismo
comando. Rechaza un título procedente de `XBOX_PLAYFAB_TITLE_ID` o del contexto guardado, incluso con
`--confirm`, e imprime el comando que se debe ejecutar en su lugar:

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

- [Validar directiva de API](https://docs.xbox.com/es/services/playfab/api-references/rest/admin/authentication/validate-api-policy.md)
- [Notas de la versión de PlayFab de 2017](https://docs.xbox.com/es/announcements/playfab/2017.md)
- [Notas de la versión de PlayFab 2017](https://docs.xbox.com/es/services/playfab/release-notes/2017.md)
- [Directiva de acceso a las API](https://docs.xbox.com/es/services/playfab/api-references/api-access-policy.md)
- [Directiva de acceso a las API en Game Manager](https://docs.xbox.com/es/services/playfab/live-service-management/gamemanager/api-access-page-doc.md)
