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

# Política de API

> Leia e atualize a política de acesso à API do título, que controla quais chamadores podem usar quais APIs do PlayFab.

Leia e atualize a política de acesso à API do título, as instruções que controlam quais chamadores
podem usar quais APIs do PlayFab. Uma política incorreta pode bloquear o acesso de todos os jogadores ao título. Você
precisa da permissão **Admin** no título; consulte
[Como a autenticação do PlayFab funciona](https://docs.xbox.com/pt-BR/tools/xbox-cli/authentication.md#how-playfab-authentication-works).

| Comando | Caminho da API do PlayFab | Descrição |
| - | - | - |
| `playfab api-policy get` | `/Admin/GetPolicy` | Obtém as instruções e a versão da política. |
| `playfab api-policy set` | `/Admin/UpdatePolicy` | Adiciona instruções à política ou a substitui. |

Os comandos `api-policy` não aceitam `--output table`.

| Opção | Comando | Obrigatória | Descrição |
| - | - | - | - |
| `--policy-name` | `get`, `set` | Não | A política. O padrão é `ApiPolicy`. |
| `--statements` | `set` | Uma destas duas | As instruções, como uma matriz JSON embutida. |
| `--statements-file` | `set` | Uma destas duas | Um arquivo que contém as instruções como uma matriz JSON. |
| `--policy-version` | `set` | Sim | A versão atual da política, que `get` retorna. O PlayFab recusa a atualização se a política tiver sido alterada desde então. |
| `--overwrite` | `set` | Não | Substitui todas as instruções da política, em vez de adicionar a elas. Consulte [Substituir a política](#replace-the-policy). |

## Adicionar instruções

Leia a política atual e a versão dela:

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

Coloque as instruções a serem adicionadas em um arquivo. Este `policy.json` nega a todos os chamadores a operação
`DeleteCharacterFromUser` da Server API:

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

* `Resource` é `pfrn:api--` seguido de um caminho de API, ou `pfrn:api--*` para todas as APIs.
* `Action` é `*`, o único valor que o PlayFab aceita.
* `Effect` é `Allow` ou `Deny`.
* `Principal` é `*` para corresponder a todos os chamadores.
* `Comment` é um texto opcional para seus próprios registros.
* `ApiConditions` é opcional e define condições como
  `{ "HasSignatureOrEncryption": "True" }`, que aceita `Any`, `True` ou `False`.

Os nomes dos campos não diferenciam maiúsculas de minúsculas. Um campo não reconhecido, como um `ApiConditions`
digitado incorretamente, é um erro, porque descartá-lo poderia ampliar o que a instrução permite.
A página [Política de acesso à API](https://learn.microsoft.com/gaming/playfab/api-references/api-access-policy) do PlayFab
descreve cada campo e mostra a política padrão que permite todas as APIs.

Em seguida, adicione as instruções, passando a versão que `get` retornou:

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

## Substituir a política

> [!CAUTION]
>
> `--overwrite` substitui a política inteira pelas instruções que você passa e descarta todas as
> instruções que você omitir. A CLI não pode restaurar a política anterior; portanto, salve primeiro a saída
> de `get`.

`--overwrite` precisa de `--confirm` e do título nomeado com `--playfab-title-id` no mesmo
comando. Ele recusa um título de `XBOX_PLAYFAB_TITLE_ID` ou do contexto salvo, mesmo com
`--confirm`, e imprime o comando a ser executado em vez disso:

```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 política de API](https://docs.xbox.com/pt-BR/services/playfab/api-references/rest/admin/authentication/validate-api-policy.md)
- [Notas de versão do PlayFab de 2017](https://docs.xbox.com/pt-BR/announcements/playfab/2017.md)
- [Notas de versão do PlayFab de 2016](https://docs.xbox.com/pt-BR/announcements/playfab/2016.md)
- [Códigos de erro globais dos métodos de API](https://docs.xbox.com/pt-BR/services/playfab/api-references/global-api-method-error-codes.md)
- [Política de acesso à API](https://docs.xbox.com/pt-BR/services/playfab/api-references/api-access-policy.md)
