> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# PFAuthenticationGetEntityRequest

> PFAuthenticationGetEntityRequest data model. This API must be called with X-SecretKey, X-Authentication or X-EntityToken headers. An optional EntityKey may.

PFAuthenticationGetEntityRequest data model. This API must be called with X-SecretKey, X-Authentication or X-EntityToken headers. An optional EntityKey may be included to attempt to set the resulting EntityToken to a specific entity, however the entity must be a relation of the caller, such as the master\_player\_account of a character. If sending X-EntityToken the account will be marked as freshly logged in and will issue a new token. If using X-Authentication or X-EntityToken the header must still be valid and cannot be expired or revoked.

## Syntax

```cpp theme={null}
typedef struct PFAuthenticationGetEntityRequest {  
    PFStringDictionaryEntry const* customTags;  
    uint32_t customTagsCount;  
    PFEntityKey const* entity;  
} PFAuthenticationGetEntityRequest;  
```

### Members

**`customTags`**   PFStringDictionaryEntry const\*<br />*may be nullptr*

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

**`customTagsCount`**   uint32\_t

Count of customTags

**`entity`**   PFEntityKey const\*<br />*may be nullptr*

(Optional) The optional entity to perform this action on. Defaults to the currently logged in entity.

## Requirements

**Header:** PFAuthenticationTypes.h

## See also

[PFAuthenticationTypes members](/services/playfab/api-references/c/pfauthenticationtypes/pfauthenticationtypes_members)


## Related topics

- [PFAuthenticationGetEntityAsync](/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationgetentityasync.md)
- [PFAuthenticationGetEntityWithSecretKeyAsync](/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationgetentitywithsecretkeyasync.md)
- [Services C API overview - PFAuthenticationTypes.h](/services/playfab/api-references/c/pfauthenticationtypes/pfauthenticationtypes_members.md)
- [PFAuthenticationValidateEntityTokenRequest](/services/playfab/api-references/c/pfauthenticationtypes/structs/pfauthenticationvalidateentitytokenrequest.md)
- [PFAuthenticationDeleteRequest](/services/playfab/api-references/c/pfauthenticationtypes/structs/pfauthenticationdeleterequest.md)