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/{instance_id}/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.

Request message for refreshing an existing Minecraft account's authentication tokens. Used to renew expired tokens without requiring the user to re-authenticate.

account*

The existing Minecraft account to refresh. Must include valid account data with refresh tokens. The account type determines which refresh mechanism is used. Offline accounts are returned unchanged (they never expire).

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/mc-auth:refresh" \  -H "Content-Type: application/json" \  -d '{    "account": {      "type": "MICROSOFT_JAVA_CREDENTIALS",      "profileId": "faebe71b-2bf8-4bdb-9b67-258e4d6aa00a",      "lastKnownName": "string"    }  }'
{  "account": {    "type": "MICROSOFT_JAVA_CREDENTIALS",    "profileId": "faebe71b-2bf8-4bdb-9b67-258e4d6aa00a",    "lastKnownName": "string",    "onlineChainJavaData": {      "authChain": {}    },    "offlineJavaData": {},    "bedrockData": {      "authChain": {}    },    "onlineSimpleJavaData": {      "accessToken": "string",      "expireTimeMs": "string"    },    "theAlteningJavaData": {      "accountToken": "string",      "accessToken": "string"    },    "config": [      {        "namespace": "string",        "entries": [          {            "key": "string",            "value": null          }        ]      }    ],    "persistentMetadata": [      {        "namespace": "string",        "entries": [          {            "key": "string",            "value": null          }        ]      }    ]  }}

How is this page?