Documentation

RegisterPlayFabUser

Registers a new Playfab user account, returning a session identifier that can subsequently be used for API calls which require an authenticated user. You must supply either a username or an email address.

Request Details

RegisterPlayFabUserRequest
Request Properties
DisplayName String

An optional parameter for setting the display name for this title (3-25 characters).

Email String

User email address attached to their account

EncryptedRequest String

Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only).

InfoRequestParameters GetPlayerCombinedInfoRequestParams

Flags for which pieces of info to return for the user.

Password String

Password for the PlayFab account (6-100 characters)

PlayerSecret String

Player secret that is used to verify API request signatures (Enterprise Only).

RequireBothUsernameAndEmail Boolean

An optional parameter that specifies whether both the username and email parameters are required. If true, both parameters are required; if false, the user must supply either the username or email parameter. The default value is true.

TitleId (required) String

Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected.

Username String

PlayFab username for the account (3-20 characters)

POST https://{{TitleID}}.playfabapi.com/Client/RegisterPlayFabUser
    Content-Type: application/json
{
  "Username": "theuser",
  "Email": "me@here.com",
  "Password": "thepassword",
  "TitleId": "1"
}
        

Response Details

Each account must have a unique email address in the PlayFab service. Once created, the account may be associated with additional accounts (Steam, Facebook, Game Center, etc.), allowing for added social network lists and achievements systems.

RegisterPlayFabUserResult
Result Properties
EntityToken EntityTokenResponse

If LoginTitlePlayerAccountEntity flag is set on the login request the title_player_account will also be logged in and returned.

PlayFabId String

PlayFab unique identifier for this newly created account.

SessionTicket String

Unique token identifying the user and game at the server level, for the current session.

SettingsForUser UserSettings

Settings specific to this user.

Username String

PlayFab unique user name.

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
  "code": 200,
  "status": "OK",
  "data": {
    "PlayFabId": "50DF92E291CCD4C3",
    "SessionTicket": "50DF92E291CCD4C3---A54F-8D3909FF54DEE10-B7817722BC94E536.A6DCCFE1C9709ABB",
    "Username": "username"
  }
}

Authentication

None

Possible Error Codes

Name Code
EmailAddressNotAvailable 1006
InvalidEmailAddress 1005
InvalidPartnerResponse 1193
InvalidPassword 1008
InvalidTitleId 1004
InvalidUsername 1007
NameNotAvailable 1058
ProfaneDisplayName 1234
UsernameNotAvailable 1009