Skip to main content
Read and update the title’s API access policy, the statements that control which callers can use which PlayFab APIs. A wrong policy can lock every player out of the title. You need Admin permission on the title; see How PlayFab authentication works. api-policy commands don’t accept --output table.

Add statements

Read the current policy and its version:
Put the statements to add in a file. This policy.json denies the Server API’s DeleteCharacterFromUser to every caller:
  • Resource is pfrn:api-- and an API path, or pfrn:api--* for every API.
  • Action is *, the only value PlayFab accepts.
  • Effect is Allow or Deny.
  • Principal is * to match every caller.
  • Comment is optional text for your own records.
  • ApiConditions is optional, and sets conditions such as { "HasSignatureOrEncryption": "True" }, which takes Any, True, or False.
Field names aren’t case-sensitive. An unrecognized field, such as a misspelled ApiConditions, is an error, because dropping it could widen what the statement allows. PlayFab’s API access policy page describes each field, and shows the default policy that allows every API. Then add the statements, passing the version that get returned:

Replace the policy

--overwrite replaces the whole policy with the statements you pass, and discards every statement you leave out. The CLI can’t restore the previous policy, so save the output of get first.
--overwrite needs --confirm, and the title named with --playfab-title-id on the same command. It refuses a title from XBOX_PLAYFAB_TITLE_ID or saved context, even with --confirm, and prints the command to run instead:
Last modified on November 18, 2026