Authentication - Get Policy

Gets the requested policy.

POST https://titleId.playfabapi.com/Admin/GetPolicy

Request Header

Name Required Type Description
X-SecretKey True
  • string

This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Request Body

Name Type Description
PolicyName
  • string

The name of the policy to read. Only supported name is 'ApiPolicy'.

Responses

Name Type Description
200 OK
400 Bad Request

This is the outer wrapper for all responses with errors

Security

X-SecretKey

This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Type: apiKey
In: header

Definitions

ApiCondition
ApiErrorWrapper

The basic wrapper around every failed API response

Conditionals
EffectType
GetPolicyRequest

Views the requested policy. Today, the only supported policy is 'ApiPolicy'.

GetPolicyResponse
PermissionStatement

ApiCondition

Name Type Description
HasSignatureOrEncryption

Require that API calls contain an RSA encrypted payload or signed headers.

ApiErrorWrapper

The basic wrapper around every failed API response

Name Type Description
code
  • integer

Numerical HTTP code

error
  • string

Playfab error code

errorCode
  • integer

Numerical PlayFab error code

errorDetails
  • object

Detailed description of individual issues with the request object

errorMessage
  • string

Description for the PlayFab errorCode

status
  • string

String HTTP code

Conditionals

Name Type Description
Any
  • string
False
  • string
True
  • string

EffectType

Name Type Description
Allow
  • string
Deny
  • string

GetPolicyRequest

Views the requested policy. Today, the only supported policy is 'ApiPolicy'.

Name Type Description
PolicyName
  • string

The name of the policy to read. Only supported name is 'ApiPolicy'.

GetPolicyResponse

Name Type Description
PolicyName
  • string

The name of the policy read.

PolicyVersion
  • number

Policy version.

Statements

The statements in the requested policy.

PermissionStatement

Name Type Description
Action
  • string

The action this statement effects. The only supported action is 'Execute'.

ApiConditions

Additional conditions to be applied for API Resources.

Comment
  • string

A comment about the statement. Intended solely for bookkeeping and debugging.

Effect

The effect this statement will have. It could be either Allow or Deny

Principal
  • string

The principal this statement will effect. The only supported principal is '*'.

Resource
  • string

The resource this statements effects. The only supported resources look like 'pfrn:api--*' for all apis, or 'pfrn:api--/Client/ConfirmPurchase' for specific apis.