358 lines
12 KiB
Plaintext
358 lines
12 KiB
Plaintext
---
|
|
id: global-api-web-api-utils-controller-get-bedrock-or-java-uuid
|
|
title: "Utility endpoint to get either a Java UUID or a Bedrock xuid"
|
|
description: "Utility endpoint to get either a Java UUID or a Bedrock xuid"
|
|
sidebar_label: "Utility endpoint to get either a Java UUID or a Bedrock xuid"
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJzlVk1v4zYQ/SvEXJoAgu11sltUt7RNgxRdYLFI0AJBENDUWGJCkdrhyBvD0H9fDCU5ju1+LHJsLpEpcebNe2843IDRzi20eYqQb7oMQoOk2QZ/XUAOVy4stLto7J+4mFw0dnLL1sVfgmcKziFNSuSHBRYUzNNDoIdHvdIPbWsLyKDRpGtkpAj53QYKjIZsI6Ehh5sKVRuRvK5RhaXiCtVH69GQXrJqnF4jQQb4rOvGoWCDIY08rrRrEXKY3Nh6PjuDLgPJvPtqfNNlYCVho7mCDCQf5DCmhgwIv7SWsICcqcUMoqmwTqF43ci3kcn6UiIdK6IhXNpnqaVQ1qt1aEn95kIoSs2oTPBLW74UIphhQPSlRVq/QOoDfRege/k4NsHHnqH5bCb/TPCMnuVRN42zJuk5fYwCerMT73U1t6McHHYquL29/lUK+xgetS93NaKwtA7VMlCtWfQm8Q7bHostDjMIX3uRB+l/7rU9EB5ymB3+/TR7t/xwvvzw3vxoziCDAUIOg/P2eBop/mc4O5bYEWuw0UHMblenO0hp0+77DNhy2jwS+qln6iVIWDyiYegkyiGkkYvn1iZL7THWF6u0L7aQJ+rzYANV6yIJuEBlC/RsjXbyO/VXLyH6ognWsxAzn50f8nJpuUJKW0pdI7EulY2KQ1Au+FIFSs+xCsQqeIPp06ERvuqoCOuwwiJ9WCGh7PZB/bUIz0obE1rPirC0kZGwGOGNuQTX2Wx+XK/eIBJQq9/1So8LQsdX/ME5RVhYQsPSin9TuXCouNL8InqXwfmbuucKPZI1ozySoSFkXqu6NZXCFdJaIVEgeG2dGmPUZTLO6w4aXxzlIUVS4yfH7Dm68HLI+a/eu/Yr7WwxCnniw/CYKawbXo+6iwdOhbD3s7P/NWESVoBhZCy2xpYG8IGV0aaS5WRM9VXaQJb1wqUGlbGbvJm64g+7QnXx6VqdkDS6s7WVmNO0JSK3zWmPUZcyTaGVMSwM7B3hbJ3l9YvROagSWWHf0UPL9Aev/Nw9aiCDGrkKMvZLTAe6jMwcpqv5NOWbyvE63Zv2083YQx1kEJFW48BvyUEOFXMT8+lUN3ZS4joi1WYSSGbiSpMVOtLNQ4ZZRNOS5TXkd/cyJJchTb1Bl/4uoi4aK3uRYl/zu8lsMhc7NiFyrZPnhpH6RjpecbudvozPPG2ctl6SpiI3A1V3sJpDNoiTjdNojzDIIN8eO/cZVCGybN1sFjriLbmuk+X+dpAuTjYKSwXkS+0iHuDa9h+cfB7a5FR9x9XkaF1PuN69k4y3KhCZRt3ehu4/3P6OIhsWtV/v4hoRvxzo910GFeoCKeHsX18Ygw3vbDw4saTAbR9cXd5A130DdnbXhw==
|
|
sidebar_class_name: "get api-method"
|
|
info_path: api/global/global-api
|
|
custom_edit_url: null
|
|
---
|
|
|
|
import ApiTabs from "@theme/ApiTabs";
|
|
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
|
|
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
|
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
|
|
import MimeTabs from "@theme/MimeTabs";
|
|
import ParamsItem from "@theme/ParamsItem";
|
|
import ResponseSamples from "@theme/ResponseSamples";
|
|
import SchemaItem from "@theme/SchemaItem";
|
|
import SchemaTabs from "@theme/SchemaTabs";
|
|
import Markdown from "@theme/Markdown";
|
|
import OperationTabs from "@theme/OperationTabs";
|
|
import TabItem from "@theme/TabItem";
|
|
|
|
<h1
|
|
className={"openapi__heading"}
|
|
>
|
|
Utility endpoint to get either a Java UUID or a Bedrock xuid
|
|
</h1>
|
|
|
|
<MethodEndpoint
|
|
method={"get"}
|
|
path={"/v2/utils/uuid/bedrock_or_java/{username}"}
|
|
>
|
|
|
|
</MethodEndpoint>
|
|
|
|
|
|
|
|
Utility endpoint to get either a Java UUID or a Bedrock xuid
|
|
|
|
## Request
|
|
|
|
<details
|
|
style={{"marginBottom":"1rem"}}
|
|
className={"openapi-markdown__details"}
|
|
data-collapsed={false}
|
|
open={true}
|
|
>
|
|
<summary
|
|
style={{}}
|
|
>
|
|
<h3
|
|
className={"openapi-markdown__details-summary-header-params"}
|
|
>
|
|
Path Parameters
|
|
</h3>
|
|
</summary><div>
|
|
<ul>
|
|
<ParamsItem
|
|
className={"paramsItem"}
|
|
param={{"description":"The username of the Minecraft player","examples":{"bedrock":{"value":".Tim203"},"java":{"value":"Tim203"}},"in":"path","name":"username","required":true,"schema":{"type":"string"}}}
|
|
>
|
|
|
|
</ParamsItem>
|
|
</ul>
|
|
</div>
|
|
</details><details
|
|
style={{"marginBottom":"1rem"}}
|
|
className={"openapi-markdown__details"}
|
|
data-collapsed={false}
|
|
open={true}
|
|
>
|
|
<summary
|
|
style={{}}
|
|
>
|
|
<h3
|
|
className={"openapi-markdown__details-summary-header-params"}
|
|
>
|
|
Query Parameters
|
|
</h3>
|
|
</summary><div>
|
|
<ul>
|
|
<ParamsItem
|
|
className={"paramsItem"}
|
|
param={{"description":"The prefix used in your Floodgate config","example":".","in":"query","name":"prefix","required":true,"schema":{"type":"string"}}}
|
|
>
|
|
|
|
</ParamsItem>
|
|
</ul>
|
|
</div>
|
|
</details><div>
|
|
<div>
|
|
<ApiTabs
|
|
label={undefined}
|
|
id={undefined}
|
|
>
|
|
<TabItem
|
|
label={"200"}
|
|
value={"200"}
|
|
>
|
|
<div>
|
|
|
|
|
|
The Bedrock xuid in Floodgate UUID format and username. Response made to be identical to the Mojang endpoint
|
|
|
|
|
|
</div><div>
|
|
<MimeTabs
|
|
className={"openapi-tabs__mime"}
|
|
schemaType={"response"}
|
|
>
|
|
<TabItem
|
|
label={"application/json"}
|
|
value={"application/json"}
|
|
>
|
|
<SchemaTabs
|
|
className={"openapi-tabs__schema"}
|
|
>
|
|
<TabItem
|
|
label={"Schema"}
|
|
value={"Schema"}
|
|
>
|
|
<details
|
|
style={{}}
|
|
className={"openapi-markdown__details response"}
|
|
data-collapsed={false}
|
|
open={true}
|
|
>
|
|
<summary
|
|
style={{}}
|
|
className={"openapi-markdown__details-summary-response"}
|
|
>
|
|
<strong>
|
|
Schema
|
|
</strong>
|
|
</summary><div
|
|
style={{"textAlign":"left","marginLeft":"1rem"}}
|
|
>
|
|
|
|
</div><ul
|
|
style={{"marginLeft":"1rem"}}
|
|
>
|
|
<SchemaItem
|
|
collapsible={false}
|
|
name={"id"}
|
|
required={true}
|
|
schemaName={"uuid"}
|
|
qualifierMessage={undefined}
|
|
schema={{"description":"The Floodgate UUID of the Bedrock player","example":"0000000000000000000901f64f65c7c3","format":"uuid","type":"string"}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"name"}
|
|
required={true}
|
|
schemaName={"string"}
|
|
qualifierMessage={undefined}
|
|
schema={{"description":"The Floodgate username","example":".Tim203","type":"string"}}
|
|
>
|
|
|
|
</SchemaItem>
|
|
</ul>
|
|
</details>
|
|
</TabItem><TabItem
|
|
label={"Example (from schema)"}
|
|
value={"Example (from schema)"}
|
|
>
|
|
<ResponseSamples
|
|
responseExample={"{\n \"id\": \"0000000000000000000901f64f65c7c3\",\n \"name\": \".Tim203\"\n}"}
|
|
language={"json"}
|
|
>
|
|
|
|
</ResponseSamples>
|
|
</TabItem>
|
|
</SchemaTabs>
|
|
</TabItem>
|
|
</MimeTabs>
|
|
</div>
|
|
</TabItem><TabItem
|
|
label={"204"}
|
|
value={"204"}
|
|
>
|
|
<div>
|
|
|
|
|
|
Either the gamertag is too long or too short once the prefix was removed or there is no Xbox account registered to the gamertag
|
|
|
|
|
|
</div><div>
|
|
|
|
</div>
|
|
</TabItem><TabItem
|
|
label={"302"}
|
|
value={"302"}
|
|
>
|
|
<div>
|
|
|
|
|
|
The player is a Java player and we'll redirect you to the Mojang endpoint for that username
|
|
|
|
|
|
</div><div>
|
|
|
|
</div>
|
|
</TabItem><TabItem
|
|
label={"400"}
|
|
value={"400"}
|
|
>
|
|
<div>
|
|
|
|
|
|
Invalid prefix (no prefix, empty or too long)
|
|
|
|
|
|
</div><div>
|
|
<MimeTabs
|
|
className={"openapi-tabs__mime"}
|
|
schemaType={"response"}
|
|
>
|
|
<TabItem
|
|
label={"application/json"}
|
|
value={"application/json"}
|
|
>
|
|
<SchemaTabs
|
|
className={"openapi-tabs__schema"}
|
|
>
|
|
<TabItem
|
|
label={"Schema"}
|
|
value={"Schema"}
|
|
>
|
|
<details
|
|
style={{}}
|
|
className={"openapi-markdown__details response"}
|
|
data-collapsed={false}
|
|
open={true}
|
|
>
|
|
<summary
|
|
style={{}}
|
|
className={"openapi-markdown__details-summary-response"}
|
|
>
|
|
<strong>
|
|
Schema
|
|
</strong>
|
|
</summary><div
|
|
style={{"textAlign":"left","marginLeft":"1rem"}}
|
|
>
|
|
|
|
</div><ul
|
|
style={{"marginLeft":"1rem"}}
|
|
>
|
|
<SchemaItem
|
|
collapsible={false}
|
|
name={"message"}
|
|
required={true}
|
|
schemaName={"string"}
|
|
qualifierMessage={undefined}
|
|
schema={{"description":"The error message","type":"string"}}
|
|
>
|
|
|
|
</SchemaItem>
|
|
</ul>
|
|
</details>
|
|
</TabItem><TabItem
|
|
label={"Example (from schema)"}
|
|
value={"Example (from schema)"}
|
|
>
|
|
<ResponseSamples
|
|
responseExample={"{\n \"message\": \"string\"\n}"}
|
|
language={"json"}
|
|
>
|
|
|
|
</ResponseSamples>
|
|
</TabItem>
|
|
</SchemaTabs>
|
|
</TabItem>
|
|
</MimeTabs>
|
|
</div>
|
|
</TabItem><TabItem
|
|
label={"503"}
|
|
value={"503"}
|
|
>
|
|
<div>
|
|
|
|
|
|
The requested account was not cached and we were not able to call the Xbox Live API (rate limited / not setup)
|
|
|
|
|
|
</div><div>
|
|
<MimeTabs
|
|
className={"openapi-tabs__mime"}
|
|
schemaType={"response"}
|
|
>
|
|
<TabItem
|
|
label={"application/json"}
|
|
value={"application/json"}
|
|
>
|
|
<SchemaTabs
|
|
className={"openapi-tabs__schema"}
|
|
>
|
|
<TabItem
|
|
label={"Schema"}
|
|
value={"Schema"}
|
|
>
|
|
<details
|
|
style={{}}
|
|
className={"openapi-markdown__details response"}
|
|
data-collapsed={false}
|
|
open={true}
|
|
>
|
|
<summary
|
|
style={{}}
|
|
className={"openapi-markdown__details-summary-response"}
|
|
>
|
|
<strong>
|
|
Schema
|
|
</strong>
|
|
</summary><div
|
|
style={{"textAlign":"left","marginLeft":"1rem"}}
|
|
>
|
|
|
|
</div><ul
|
|
style={{"marginLeft":"1rem"}}
|
|
>
|
|
<SchemaItem
|
|
collapsible={false}
|
|
name={"message"}
|
|
required={true}
|
|
schemaName={"string"}
|
|
qualifierMessage={undefined}
|
|
schema={{"description":"The error message","type":"string"}}
|
|
>
|
|
|
|
</SchemaItem>
|
|
</ul>
|
|
</details>
|
|
</TabItem><TabItem
|
|
label={"Example (from schema)"}
|
|
value={"Example (from schema)"}
|
|
>
|
|
<ResponseSamples
|
|
responseExample={"{\n \"message\": \"string\"\n}"}
|
|
language={"json"}
|
|
>
|
|
|
|
</ResponseSamples>
|
|
</TabItem>
|
|
</SchemaTabs>
|
|
</TabItem>
|
|
</MimeTabs>
|
|
</div>
|
|
</TabItem>
|
|
</ApiTabs>
|
|
</div>
|
|
</div>
|
|
|