Account Management - Set Global Policy

Sets the global title access policy

POST https://titleId.playfabapi.com/Profile/SetGlobalPolicy

Request Header

Name Required Type Description
X-EntityToken True
  • string

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Request Body

Name Type Description
CustomTags
  • object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Permissions

The permissions that govern access to all entities under this title or namespace.

Responses

Name Type Description
200 OK
400 Bad Request

This is the outer wrapper for all responses with errors

Security

X-EntityToken

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Type: apiKey
In: header

Definitions

ApiErrorWrapper

The basic wrapper around every failed API response

EffectType
EntityPermissionStatement
SetGlobalPolicyRequest

Updates the title access policy that is used before the profile's policy is inspected during a request. Policies are compiled and cached for several minutes so an update here may not be reflected in behavior for a short time.

SetGlobalPolicyResponse

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

EffectType

Name Type Description
Allow
  • string
Deny
  • string

EntityPermissionStatement

Name Type Description
Action
  • string

The action this statement effects. May be 'Read', 'Write' or '*' for both read and write.

Comment
  • string

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

Condition
  • object

Additional conditions to be applied for entity resources.

Effect

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

Principal
  • object

The principal this statement will effect.

Resource
  • string

The resource this statements effects. Similar to 'pfrn:data--title![Title ID]/Profile/*'

SetGlobalPolicyRequest

Updates the title access policy that is used before the profile's policy is inspected during a request. Policies are compiled and cached for several minutes so an update here may not be reflected in behavior for a short time.

Name Type Description
CustomTags
  • object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Permissions

The permissions that govern access to all entities under this title or namespace.

SetGlobalPolicyResponse