SoulFire LogoSoulFire

Refresh Minecraft account

Refreshes the authentication tokens for an existing Minecraft account. Used to renew expired access tokens using stored refresh tokens. For Microsoft accounts, this refreshes the Minecraft token, profile, and player certificates. For offline accounts, returns the account unchanged (offline accounts never expire).

POST
/v1/instances/p0/mc-auth:refresh

Refreshes the authentication tokens for an existing Minecraft account. Used to renew expired access tokens using stored refresh tokens.

For Microsoft accounts, this refreshes the Minecraft token, profile, and player certificates. For offline accounts, returns the account unchanged (offline accounts never expire).

Authorization

AuthorizationBearer <token>

Preferred API authentication. Use a JWT with the api audience.

In: header

Path Parameters

instance_id*string

The UUID of the SoulFire instance context for the refresh operation. Must be a valid UUID string. The instance must exist and the caller must have AUTHENTICATE_MC_ACCOUNT permission for this instance.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

account.type*

The authentication type used for this account. Determines which account_data field is populated.

account.profile_id*string

The unique profile identifier (UUID) for this account. For online accounts: The official Minecraft profile UUID from Microsoft. For offline accounts: A deterministic UUID derived from the username. Format: Standard UUID string (e.g., "550e8400-e29b-41d4-a716-446655440000").

Formatuuid
account.last_known_name*string

The last known username/gamertag for this account. Updated during authentication and refresh operations. For Java: The Minecraft username (up to 16 characters). For Bedrock: The Xbox gamertag.

account.online_chain_java_data.auth_chain*

JSON structure containing the complete authentication chain from minecraftauth library. Includes Microsoft OAuth tokens, Xbox Live tokens, and Minecraft access tokens. This data can be refreshed to obtain new tokens without re-authentication.

account.bedrock_data.auth_chain*

JSON structure containing the complete Bedrock authentication chain. Includes Xbox Live tokens and Bedrock-specific session data. Compatible with the ViaBedrock protocol implementation.

account.online_simple_java_data.access_token*string

The raw Minecraft access token (JWT).

account.online_simple_java_data.expire_time_ms*integer

Token expiry time in milliseconds since epoch.

Formatint64
account.config.namespace*string
account.config.entries.key*string
account.config.entries.value*
account.persistent_metadata.namespace*string
account.persistent_metadata.entries.key*string
account.persistent_metadata.entries.value*

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://127.0.0.1:38765/v1/instances/p0/mc-auth:refresh" \  -H "Content-Type: application/json" \  -d '{    "account.type": {},    "account.profile_id": "8dec25d7-d125-46da-8314-b43b3c5640ed",    "account.last_known_name": "string",    "account.online_chain_java_data.auth_chain": {},    "account.bedrock_data.auth_chain": {},    "account.online_simple_java_data.access_token": "string",    "account.online_simple_java_data.expire_time_ms": 0,    "account.config.namespace": "string",    "account.config.entries.key": "string",    "account.config.entries.value": {},    "account.persistent_metadata.namespace": "string",    "account.persistent_metadata.entries.key": "string",    "account.persistent_metadata.entries.value": {}  }'
{  "account": {    "type": "MICROSOFT_JAVA_CREDENTIALS",    "profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",    "last_known_name": "string",    "online_chain_java_data": {      "auth_chain": {        "fields": {          "property1": {            "null_value": "NULL_VALUE",            "number_value": 0.1,            "string_value": "string",            "bool_value": true,            "struct_value": {              "fields": {}            },            "list_value": {              "values": [                {                  "null_value": "NULL_VALUE",                  "number_value": 0.1,                  "string_value": "string",                  "bool_value": true,                  "struct_value": {                    "fields": {}                  },                  "list_value": {                    "values": []                  }                }              ]            }          },          "property2": {            "null_value": "NULL_VALUE",            "number_value": 0.1,            "string_value": "string",            "bool_value": true,            "struct_value": {              "fields": {}            },            "list_value": {              "values": [                {                  "null_value": "NULL_VALUE",                  "number_value": 0.1,                  "string_value": "string",                  "bool_value": true,                  "struct_value": {                    "fields": {}                  },                  "list_value": {                    "values": []                  }                }              ]            }          }        }      }    },    "offline_java_data": {},    "bedrock_data": {      "auth_chain": {        "fields": {          "property1": {            "null_value": "NULL_VALUE",            "number_value": 0.1,            "string_value": "string",            "bool_value": true,            "struct_value": {              "fields": {}            },            "list_value": {              "values": [                {                  "null_value": "NULL_VALUE",                  "number_value": 0.1,                  "string_value": "string",                  "bool_value": true,                  "struct_value": {                    "fields": {}                  },                  "list_value": {                    "values": []                  }                }              ]            }          },          "property2": {            "null_value": "NULL_VALUE",            "number_value": 0.1,            "string_value": "string",            "bool_value": true,            "struct_value": {              "fields": {}            },            "list_value": {              "values": [                {                  "null_value": "NULL_VALUE",                  "number_value": 0.1,                  "string_value": "string",                  "bool_value": true,                  "struct_value": {                    "fields": {}                  },                  "list_value": {                    "values": []                  }                }              ]            }          }        }      }    },    "online_simple_java_data": {      "access_token": "string",      "expire_time_ms": 0    },    "config": [      {        "namespace": "string",        "entries": [          {            "key": "string",            "value": {              "null_value": "NULL_VALUE",              "number_value": 0.1,              "string_value": "string",              "bool_value": true,              "struct_value": {                "fields": {                  "property1": {                    "null_value": "NULL_VALUE",                    "number_value": 0.1,                    "string_value": "string",                    "bool_value": true,                    "struct_value": {                      "fields": {}                    },                    "list_value": {                      "values": [                        {                          "null_value": "NULL_VALUE",                          "number_value": 0.1,                          "string_value": "string",                          "bool_value": true,                          "struct_value": {                            "fields": {}                          },                          "list_value": {                            "values": []                          }                        }                      ]                    }                  },                  "property2": {                    "null_value": "NULL_VALUE",                    "number_value": 0.1,                    "string_value": "string",                    "bool_value": true,                    "struct_value": {                      "fields": {}                    },                    "list_value": {                      "values": [                        {                          "null_value": "NULL_VALUE",                          "number_value": 0.1,                          "string_value": "string",                          "bool_value": true,                          "struct_value": {                            "fields": {}                          },                          "list_value": {                            "values": []                          }                        }                      ]                    }                  }                }              },              "list_value": {                "values": [                  {                    "null_value": "NULL_VALUE",                    "number_value": 0.1,                    "string_value": "string",                    "bool_value": true,                    "struct_value": {                      "fields": {                        "property1": {                          "null_value": "NULL_VALUE",                          "number_value": 0.1,                          "string_value": "string",                          "bool_value": true,                          "struct_value": {                            "fields": {}                          },                          "list_value": {                            "values": []                          }                        },                        "property2": {                          "null_value": "NULL_VALUE",                          "number_value": 0.1,                          "string_value": "string",                          "bool_value": true,                          "struct_value": {                            "fields": {}                          },                          "list_value": {                            "values": []                          }                        }                      }                    },                    "list_value": {                      "values": []                    }                  }                ]              }            }          }        ]      }    ],    "persistent_metadata": [      {        "namespace": "string",        "entries": [          {            "key": "string",            "value": {              "null_value": "NULL_VALUE",              "number_value": 0.1,              "string_value": "string",              "bool_value": true,              "struct_value": {                "fields": {                  "property1": {                    "null_value": "NULL_VALUE",                    "number_value": 0.1,                    "string_value": "string",                    "bool_value": true,                    "struct_value": {                      "fields": {}                    },                    "list_value": {                      "values": [                        {                          "null_value": "NULL_VALUE",                          "number_value": 0.1,                          "string_value": "string",                          "bool_value": true,                          "struct_value": {                            "fields": {}                          },                          "list_value": {                            "values": []                          }                        }                      ]                    }                  },                  "property2": {                    "null_value": "NULL_VALUE",                    "number_value": 0.1,                    "string_value": "string",                    "bool_value": true,                    "struct_value": {                      "fields": {}                    },                    "list_value": {                      "values": [                        {                          "null_value": "NULL_VALUE",                          "number_value": 0.1,                          "string_value": "string",                          "bool_value": true,                          "struct_value": {                            "fields": {}                          },                          "list_value": {                            "values": []                          }                        }                      ]                    }                  }                }              },              "list_value": {                "values": [                  {                    "null_value": "NULL_VALUE",                    "number_value": 0.1,                    "string_value": "string",                    "bool_value": true,                    "struct_value": {                      "fields": {                        "property1": {                          "null_value": "NULL_VALUE",                          "number_value": 0.1,                          "string_value": "string",                          "bool_value": true,                          "struct_value": {                            "fields": {}                          },                          "list_value": {                            "values": []                          }                        },                        "property2": {                          "null_value": "NULL_VALUE",                          "number_value": 0.1,                          "string_value": "string",                          "bool_value": true,                          "struct_value": {                            "fields": {}                          },                          "list_value": {                            "values": []                          }                        }                      }                    },                    "list_value": {                      "values": []                    }                  }                ]              }            }          }        ]      }    ]  }}

How is this page?