---
updatedAt: 2025-09-22T21:45:12.000Z
agentTools:
  projectIndex: https://docs.blockus.com/llms.txt
---

# Login with PlayFab

Login with PlayFab allows the player to login with their PlayFab account. See details in PlayFab integration

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Blockus api",
    "version": "1.0"
  },
  "paths": {
    "/v1/playersWithPlayFab/login": {
      "post": {
        "operationId": "loginWithPlayFab",
        "tags": [
          "Player Routes PlayFab Integration"
        ],
        "description": "Login with PlayFab allows the player to login with their PlayFab account. See details in PlayFab integration",
        "summary": "Login with PlayFab",
        "parameters": [
          {
            "name": "X-EntityToken",
            "in": "header",
            "description": "playFab entity token",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PlayerLoginWithPlayFabResponse"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "409": {
            "description": "Conflict Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "500": {
            "description": "Server Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          }
        }
      }
    }
  },
  "tags": [
    {
      "name": "Player Routes PlayFab Integration"
    }
  ],
  "externalDocs": {
    "url": "https://www.blockus.gg/"
  },
  "servers": [
    {
      "url": "https://api.blockus.net"
    }
  ],
  "components": {
    "schemas": {
      "ApiError": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "Message",
            "example": "<Error Message>"
          },
          "code": {
            "type": "number",
            "description": "Code",
            "example": "<Status Code>"
          },
          "stack": {
            "type": "object",
            "description": "Stack",
            "example": "<Status Stack>"
          },
          "rootCause": {
            "type": "object",
            "description": "RootCause",
            "example": "<Status Stack>"
          }
        },
        "required": [
          "message",
          "code",
          "stack",
          "rootCause"
        ],
        "description": "API Error"
      },
      "PlayerLoginWithPlayFabResponse": {
        "type": "object",
        "properties": {
          "accessToken": {
            "type": "string",
            "description": "Access Token",
            "example": "XXX-XXX-XXX"
          }
        },
        "required": [
          "accessToken"
        ],
        "description": "Player Login With PlayFab Response"
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```