Account Management - Set Profile Policy

Service:

Profiles

API Version:

241122

Sets the profiles access policy

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

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	Required	Type	Description
Entity	True	EntityKey	The entity to perform this action on.
Statements	True	EntityPermissionStatement[]	The statements to include in the access policy.
CustomTags		object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Responses

Name	Type	Description
200 OK	SetEntityProfilePolicyResponse
400 Bad Request	ApiErrorWrapper	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

Name	Description
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	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

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://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types

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	EffectType	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
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
Entity	EntityKey	The entity to perform this action on.
Statements	EntityPermissionStatement[]	The statements to include in the access policy.

SetEntityProfilePolicyResponse

Name	Type	Description
Permissions	EntityPermissionStatement[]	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.