Documentation

GetPolicy

Gets the requested policy.

Request Details

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

GetPolicyRequest
Request Properties
PolicyName String

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

POST https://{{TitleID}}.playfabapi.com/Admin/GetPolicy
    Content-Type: application/json
    X-SecretKey: <developer_secret_key>
{
  "PolicyName": "ApiPolicy"
}
        

Response Details

GetPolicyResponse
Result Properties
PolicyName String

The name of the policy read.

Statements List<PermissionStatement>

The statements in the requested policy.

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
  "code": 200,
  "status": "OK",
  "data": {
    "PolicyName": "ApiPolicy",
    "Statements": [
      {
        "Resource": "pfrn:api--*",
        "Action": "*",
        "Effect": "Allow",
        "Principal": "*",
        "Comment": "The default allow all policy"
      },
      {
        "Resource": "pfrn:api--/Client/ConfirmPurchase",
        "Action": "*",
        "Effect": "Allow",
        "Principal": "*",
        "Comment": "This statement allows only request to ConfirmPurchase"
      }
    ]
  }
}

Authentication

SecretKey

Possible Error Codes

Name Code