> ## 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 액세스 정책을 읽고 업데이트합니다.

어떤 호출자가 어떤 PlayFab API를 사용할 수 있는지 제어하는 문인 타이틀의 API 액세스 정책을 읽고
업데이트합니다. 정책이 잘못되면 모든 플레이어가 타이틀에서 차단될 수 있습니다. 타이틀에 대한 **Admin**
권한이 필요합니다.
[PlayFab 인증 작동 방식](https://docs.xbox.com/ko/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` | 둘 중 하나 | 인라인 JSON 배열로 지정한 문입니다. |
| `--statements-file` | `set` | 둘 중 하나 | 문을 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`는 선택 사항이며, `Any`, `True` 또는 `False`를 사용하는
  `{ "HasSignatureOrEncryption": "True" }` 같은 조건을 설정합니다.

필드 이름은 대/소문자를 구분하지 않습니다. 철자가 틀린 `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/ko/services/playfab/api-references/rest/admin/authentication/validate-api-policy.md)
- [Economy v2 설정 개요](https://docs.xbox.com/ko/services/playfab/economy-monetization/economy-v2/settings.md)
- [플레이어 암호화 서비스](https://docs.xbox.com/ko/services/playfab/identity/player-identity/encryption/player-encryption-services.md)
- [API 액세스 정책](https://docs.xbox.com/ko/services/playfab/api-references/api-access-policy.md)
- [Game Manager의 API 액세스 정책](https://docs.xbox.com/ko/services/playfab/live-service-management/gamemanager/api-access-page-doc.md)
