Account Management - Set Profile Policy

Sets the profiles access policy

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

Request Body

Name Required Type Description
Entity True

The entity to perform this action on.

Statements

The statements to include in the access policy.

Responses

Name Type Description
200 OK
400 Bad Request

This is the outer-wrapper for all responses with errors

Security

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
EntityKey

Combined entity type and ID structure which uniquely identifies a single entity.

EntityPermissionStatement
SetEntityProfilePolicyRequest

This will set the access policy statements on the given entity profile. This is not additive, any existing statements will be replaced with the statements in this request.

SetEntityProfilePolicyResponse

ApiErrorWrapper

The basic wrapper around every failed API response

Name Type Description
code
  • number

Numerical HTTP code

error
  • string

Playfab error code

errorCode
  • number

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

EntityKey

Combined entity type and ID structure which uniquely identifies a single entity.

Name Type Description
Id
  • string

Unique ID of the entity.

Type
  • string

Entity type. See https://api.playfab.com/docs/tutorials/entities/entitytypes

TypeString
  • string

Alternate name for Type.

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/*'

SetEntityProfilePolicyRequest

This will set the access policy statements on the given entity profile. This is not additive, any existing statements will be replaced with the statements in this request.

Name Type Description
Entity

The entity to perform this action on.

Statements

The statements to include in the access policy.

SetEntityProfilePolicyResponse

Name Type Description
Permissions

The permissions that govern access to this entity profile and its properties. Only includes permissions set on this profile, not global statements from titles and namespaces.

Error Codes

Name Code
NotAuthenticated 1074
NotAuthorized 1089
ProfileDoesNotExist 1298