Auth v1

Reference for the Auth v1 endpoints on Roblox.

Base URL: https://auth.roblox.com

Endpoints

Method	Path	Name
`GET`	`/v1/account-creation/metadata`	`getAccountCreationMetadata`
`GET`	`/v1/account/pin`	`getAccountPin`
`POST`	`/v1/account/pin`	`postAccountPin`
`DELETE`	`/v1/account/pin`	`deleteAccountPin`
`PATCH`	`/v1/account/pin`	`patchAccountPin`
`POST`	`/v1/account/pin/lock`	`postAccountPinLock`
`POST`	`/v1/account/pin/unlock`	`postAccountPinUnlock`
`GET`	`/v1/auth/metadata`	`getAuthMetadata`
`GET`	`/v1/client-assertion`	`getClientAssertion`
`POST`	`/v1/external/:identityProviderId/sso/native/nonce`	`postExternalIdentityprovideridSsoNativeNonce`
`GET`	`/v1/external/:identityProviderId/sso/oauth/callback`	`getExternalIdentityprovideridSsoOauthCallback`
`POST`	`/v1/external/:identityProviderId/sso/oauth/callback`	`postExternalIdentityprovideridSsoOauthCallback`
`GET`	`/v1/external/:identityProviderId/sso/oauth/init`	`getExternalIdentityprovideridSsoOauthInit`
`POST`	`/v1/external/:identityProviderId/sso/saml/assertion-consumer-service`	`postExternalIdentityprovideridSsoSamlAssertionConsumerService`
`POST`	`/v1/external/access`	`postExternalAccess`
`POST`	`/v1/external/login`	`postExternalLogin`
`POST`	`/v1/external/loginAndLink`	`postExternalLoginandlink`
`POST`	`/v1/external/signup`	`postExternalSignup`
`POST`	`/v1/external/unlink`	`postExternalUnlink`
`POST`	`/v1/identity-verification/login`	`postIdentityVerificationLogin`
`POST`	`/v1/identity/initialize-login`	`postIdentityInitializeLogin`
`POST`	`/v1/login`	`postLogin`
`POST`	`/v1/login/linked`	`postLoginLinked`
`POST`	`/v1/logout`	`postLogout`
`POST`	`/v1/logoutfromallsessionsandreauthenticate`	`postLogoutfromallsessionsandreauthenticate`
`GET`	`/v1/metadata`	`getMetadata`
`POST`	`/v1/passkey/DeleteCredentialBatch`	`postPasskeyDeletecredentialbatch`
`POST`	`/v1/passkey/finish-ar-preauth-registration`	`postPasskeyFinishArPreauthRegistration`
`POST`	`/v1/passkey/finish-preauth-registration`	`postPasskeyFinishPreauthRegistration`
`POST`	`/v1/passkey/FinishRegistration`	`postPasskeyFinishregistration`
`POST`	`/v1/passkey/ListCredentials`	`postPasskeyListcredentials`
`POST`	`/v1/passkey/RenameCredential`	`postPasskeyRenamecredential`
`POST`	`/v1/passkey/start-authentication-by-user`	`postPasskeyStartAuthenticationByUser`
`POST`	`/v1/passkey/start-preauth-registration`	`postPasskeyStartPreauthRegistration`
`POST`	`/v1/passkey/StartAuthentication`	`postPasskeyStartauthentication`
`POST`	`/v1/passkey/StartRegistration`	`postPasskeyStartregistration`
`GET`	`/v1/passkey/su-eligibility`	`getPasskeySuEligibility`
`GET`	`/v1/passwords/validate`	`getPasswordsValidate`
`POST`	`/v1/passwords/validate`	`postPasswordsValidate`
`GET`	`/v1/recovery/metadata`	`getRecoveryMetadata`
`GET`	`/v1/revert/account`	`getRevertAccount`
`POST`	`/v1/revert/account`	`postRevertAccount`
`POST`	`/v1/revert/invalidate-tickets`	`postRevertInvalidateTickets`
`POST`	`/v1/session/refresh`	`postSessionRefresh`
`POST`	`/v1/signup`	`postSignup`
`POST`	`/v1/signup/linked`	`postSignupLinked`
`POST`	`/v1/social/:provider/disconnect`	`postSocialProviderDisconnect`
`GET`	`/v1/social/connected-providers`	`getSocialConnectedProviders`
`POST`	`/v1/user/passwords/change`	`postUserPasswordsChange`
`POST`	`/v1/username`	`postUsername`
`GET`	`/v1/username/change/price`	`getUsernameChangePrice`
`GET`	`/v1/usernames`	`getUsernames`
`POST`	`/v1/usernames/recover`	`postUsernamesRecover`
`GET`	`/v1/usernames/validate`	`getUsernamesValidate`
`POST`	`/v1/usernames/validate`	`postUsernamesValidate`
`GET`	`/v1/validators/email`	`getValidatorsEmail`
`GET`	`/v1/validators/recommendedUsernameFromDisplayName`	`getValidatorsRecommendedusernamefromdisplayname`
`POST`	`/v1/validators/recommendedUsernameFromDisplayName`	`postValidatorsRecommendedusernamefromdisplayname`
`GET`	`/v1/validators/username`	`getValidatorsUsername`
`POST`	`/v1/validators/username`	`postValidatorsUsername`
`GET`	`/v1/xbox/connection`	`getXboxConnection`
`POST`	`/v1/xbox/disconnect`	`postXboxDisconnect`
`GET`	`/v1/xbox/get-login-consecutive-days`	`getXboxGetLoginConsecutiveDays`
`POST`	`/v1/xbox/translate`	`postXboxTranslate`

`getAccountCreationMetadata`

GET /v1/account-creation/metadata

Get metadata for adding auth methods.

Usage

import { fetchApi } from 'rozod';
import { getAccountCreationMetadata } from 'rozod/endpoints/authv1';

const data = await fetchApi(getAccountCreationMetadata, undefined);

Response

Field	Type	Description
`isEligibleForALSignup`	`boolean`

`getAccountPin`

GET /v1/account/pin

Gets the account pin status.

Usage

import { fetchApi } from 'rozod';
import { getAccountPin } from 'rozod/endpoints/authv1';

const data = await fetchApi(getAccountPin, undefined);

Response

Field	Type	Description
`isEnabled`	`boolean`
`unlockedUntil`	`number`

Errors

Status	Description
401	0: Authorization has been denied for this request.

`postAccountPin`

POST /v1/account/pin

Request to create the account pin.

Usage

import { fetchApi } from 'rozod';
import { postAccountPin } from 'rozod/endpoints/authv1';

const data = await fetchApi(postAccountPin, {
  body: { /* ... */ }
});

Request Body

Field	Type	Description
`pin`	`string`
`reauthenticationToken`	`string`

Response

Field	Type	Description
`success`	`boolean`

Errors

Status	Description
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed

`deleteAccountPin`

DELETE /v1/account/pin

Request for deletes the account pin from the account.

Usage

import { fetchApi } from 'rozod';
import { deleteAccountPin } from 'rozod/endpoints/authv1';

const data = await fetchApi(deleteAccountPin, {
  body: { /* ... */ }
});

Request Body

Type: ModelsAccountPinRequest.optional()

Response

Field	Type	Description
`success`	`boolean`

Errors

Status	Description
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed

`patchAccountPin`

PATCH /v1/account/pin

Request made to update the account pin on the account.

Usage

import { fetchApi } from 'rozod';
import { patchAccountPin } from 'rozod/endpoints/authv1';

const data = await fetchApi(patchAccountPin, {
  body: { /* ... */ }
});

Request Body

Field	Type	Description
`pin`	`string`
`reauthenticationToken`	`string`

Response

Field	Type	Description
`success`	`boolean`

Errors

Status	Description
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed

`postAccountPinLock`

POST /v1/account/pin/lock

Request to locks the account which has an account pin enabled.

Usage

import { fetchApi } from 'rozod';
import { postAccountPinLock } from 'rozod/endpoints/authv1';

const data = await fetchApi(postAccountPinLock, undefined);

Response

Field	Type	Description
`success`	`boolean`

Errors

Status	Description
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed

`postAccountPinUnlock`

POST /v1/account/pin/unlock

Requests to unlock the account pin.

Usage

import { fetchApi } from 'rozod';
import { postAccountPinUnlock } from 'rozod/endpoints/authv1';

const data = await fetchApi(postAccountPinUnlock, {
  body: { /* ... */ }
});

Request Body

Field	Type	Description
`pin`	`string`
`reauthenticationToken`	`string`

Response

Field	Type	Description
`unlockedUntil`	`number`

Errors

Status	Description
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed

`getAuthMetadata`

GET /v1/auth/metadata

Gets Auth meta data

Usage

import { fetchApi } from 'rozod';
import { getAuthMetadata } from 'rozod/endpoints/authv1';

const data = await fetchApi(getAuthMetadata, undefined);

Response

Field	Type	Description
`cookieLawNoticeTimeout`	`number`

`getClientAssertion`

GET /v1/client-assertion

Creates a client assertion to be used when generating an auth ticket.

Usage

import { fetchApi } from 'rozod';
import { getClientAssertion } from 'rozod/endpoints/authv1';

const data = await fetchApi(getClientAssertion, undefined);

Response

Field	Type	Description
`clientAssertion`	`string`

Errors

Status	Description
401	0: Authorization has been denied for this request.

`postExternalIdentityprovideridSsoNativeNonce`

POST /v1/external/:identityProviderId/sso/native/nonce

Reserves a nonce for a native SSO sign-in attempt.

Usage

import { fetchApi } from 'rozod';
import { postExternalIdentityprovideridSsoNativeNonce } from 'rozod/endpoints/authv1';

const data = await fetchApi(postExternalIdentityprovideridSsoNativeNonce, {
  identityProviderId: /* integer */
});

Parameters

Name	Type	Required	Description
`identityProviderId`	`integer`	Yes

Response

Field	Type	Description
`nonce`	`string`

`getExternalIdentityprovideridSsoOauthCallback`

GET /v1/external/:identityProviderId/sso/oauth/callback

OAuth callback for identity providers that return the authorization code on a GET redirect (Okta, Google).

Usage

import { fetchApi } from 'rozod';
import { getExternalIdentityprovideridSsoOauthCallback } from 'rozod/endpoints/authv1';

const data = await fetchApi(getExternalIdentityprovideridSsoOauthCallback, {
  identityProviderId: /* integer */,
  code: /* string */,
  state: /* string */
});

Parameters

Name	Type	Required
`identityProviderId`	`integer`	Yes
`code`	`string`	Yes
`state`	`string`	Yes

Response

Type: unknown

Errors

Status	Description
302	Redirect

`postExternalIdentityprovideridSsoOauthCallback`

POST /v1/external/:identityProviderId/sso/oauth/callback

OAuth callback for identity providers that POST the authorization code as form fields (Apple form_post).

Usage

import { fetchApi } from 'rozod';
import { postExternalIdentityprovideridSsoOauthCallback } from 'rozod/endpoints/authv1';

const data = await fetchApi(postExternalIdentityprovideridSsoOauthCallback, {
  identityProviderId: /* integer */,
  body: { /* ... */ }
});

Parameters

Name	Type	Required	Description
`identityProviderId`	`integer`	Yes

Request Body

Type: unknown

Response

Type: unknown

Errors

Status	Description
302	Redirect

`getExternalIdentityprovideridSsoOauthInit`

GET /v1/external/:identityProviderId/sso/oauth/init

Signs a user up for Roblox and links the account to the authenticated external provider ID via OAuth.

Usage

import { fetchApi } from 'rozod';
import { getExternalIdentityprovideridSsoOauthInit } from 'rozod/endpoints/authv1';

const data = await fetchApi(getExternalIdentityprovideridSsoOauthInit, {
  identityProviderId: /* integer */,
  postAuthenticationIntentId: /* string */
});

Parameters

Name	Type	Required	Description
`identityProviderId`	`integer`	Yes	The identity provider to authenticate against.
`postAuthenticationIntentId`	`string`	Yes	Which post-authentication intent to carry out at the end of the handshake. Optional, and omitting it selects the provider’s web redirect.

Response

Type: unknown

Errors

Status	Description
302	Redirect

`postExternalIdentityprovideridSsoSamlAssertionConsumerService`

POST /v1/external/:identityProviderId/sso/saml/assertion-consumer-service

SAML Assertion Consumer Service endpoint that external identity provider calls post user authentication.

Usage

import { fetchApi } from 'rozod';
import { postExternalIdentityprovideridSsoSamlAssertionConsumerService } from 'rozod/endpoints/authv1';

const data = await fetchApi(postExternalIdentityprovideridSsoSamlAssertionConsumerService, {
  identityProviderId: /* integer */,
  body: { /* ... */ }
});

Parameters

Name	Type	Required	Description
`identityProviderId`	`integer`	Yes

Request Body

Field	Type	Description
`SAMLResponse`	`string`
`RelayState`	`string`

Response

Type: unknown

Errors

Status	Description
302	Redirect

`postExternalAccess`

POST /v1/external/access

Signs a user up for Roblox and links the account to the authenticated external provider ID.

Usage

import { fetchApi } from 'rozod';
import { postExternalAccess } from 'rozod/endpoints/authv1';

const data = await fetchApi(postExternalAccess, {
  body: { /* ... */ }
});

Request Body

Field	Type	Description
`authenticationProof`	`string`
`identityProviderPlatformType`	`“Undefined”	“Xbox”
`postAuthenticationIntentId`	`string`
`additionalInfoPayload`	`object`	See below

Response

Field	Type	Description
`placeId`	`number`
`isolationContext`	`string`
`launchData`	`string`

`postExternalLogin`

POST /v1/external/login

Logs in a user to Roblox based on the user’s authenticated external provider session

Usage

import { fetchApi } from 'rozod';
import { postExternalLogin } from 'rozod/endpoints/authv1';

const data = await fetchApi(postExternalLogin, {
  body: { /* ... */ }
});

Request Body

Field	Type	Description
`identityProvider`	`0	1
`additionalData`	`object`	See below
`authenticationProof`	`string`

Response

Field	Type	Description
`success`	`boolean`

Errors

Status	Description
400	30: Platform is not supported for SSO login.
401	31: No linked account found for SSO login.
403	0: Token Validation Failed
500	0: An unexpected error occurred.
501	0: An unexpected error occurred.

`postExternalLoginandlink`

POST /v1/external/loginAndLink

Deprecated endpoint

Usage

import { fetchApi } from 'rozod';
import { postExternalLoginandlink } from 'rozod/endpoints/authv1';

const data = await fetchApi(postExternalLoginandlink, {
  body: { /* ... */ }
});

Request Body

Field	Type	Description
`ctype`	`“Email”	“Username”
`cvalue`	`string`
`password`	`string`
`authenticationProof`	`string`
`IdentityProviderPlatformType`	`“Undefined”	“Xbox”
`additionalInfoPayload`	`object`	See below

Response

Field	Type	Description
`user`	`object`	See below
`twoStepVerificationData`	`object`	See below
`identityVerificationLoginTicket`	`string`
`isBanned`	`boolean`
`accountBlob`	`string`
`shouldUpdateEmail`	`boolean`
`recoveryEmail`	`string`
`passkeyRegistrationSucceeded`	`boolean`
`shouldAutoLoginFromRecovery`	`boolean`
`shouldPrompt2svRemoval`	`boolean`
`shouldPromptPasskeyAddition`	`boolean`
`shouldPromptCredentialInvalidation`	`boolean`

user fields:

Field	Type	Description
`id`	`number`
`name`	`string`
`displayName`	`string`

twoStepVerificationData fields:

Field	Type	Description
`mediaType`	`“Email”	“SMS”
`ticket`	`string`

Errors

Status	Description
403	0: Token Validation Failed

`postExternalSignup`

POST /v1/external/signup

Signs a user up for Roblox and links the account to the authenticated external provider ID

Usage

import { fetchApi } from 'rozod';
import { postExternalSignup } from 'rozod/endpoints/authv1';

const data = await fetchApi(postExternalSignup, {
  body: { /* ... */ }
});

Request Body

Field	Type	Description
`username`	`string`
`password`	`string`
`birthday`	`string`
`locale`	`string`
`authenticationProof`	`string`
`IdentityProviderPlatformType`	`“Undefined”	“Xbox”
`additionalInfoPayload`	`object`	See below

Response

Type: unknown

Errors

Status	Description
403	0: Token Validation Failed

`postExternalUnlink`

POST /v1/external/unlink

Unlink the logged in Roblox account from the current external provider ID

Usage

import { fetchApi } from 'rozod';
import { postExternalUnlink } from 'rozod/endpoints/authv1';

const data = await fetchApi(postExternalUnlink, {
  body: { /* ... */ }
});

Request Body

Field	Type	Description
`IdentityProviderPlatformType`	`“Undefined”	“Xbox”
`additionalInfoPayload`	`object`	See below

Response

Type: unknown

Errors

Status	Description
403	0: Token Validation Failed

`postIdentityVerificationLogin`

POST /v1/identity-verification/login

Endpoint for login with identity verification

Usage

import { fetchApi } from 'rozod';
import { postIdentityVerificationLogin } from 'rozod/endpoints/authv1';

const data = await fetchApi(postIdentityVerificationLogin, {
  body: { /* ... */ }
});

Request Body

Field	Type	Description
`loginTicket`	`string`
`resultToken`	`string`

Response

Type: unknown

Errors

Status	Description
403	0: Token Validation Failed 1: Invalid login ticket. 2: Invalid result token. 3: Invalid user. 4: Authentication failure.

`postIdentityInitializeLogin`

POST /v1/identity/initialize-login

Initiates identifier-first login flow by returning a list of login methods for user(s).

Usage

import { fetchApi } from 'rozod';
import { postIdentityInitializeLogin } from 'rozod/endpoints/authv1';

const data = await fetchApi(postIdentityInitializeLogin, {
  body: { /* ... */ }
});

Request Body

Field	Type	Description
`ctype`	`0	1
`cvalue`	`string`
`captchaId`	`string \| undefined`
`captchaToken`	`string \| undefined`
`captchaProvider`	`string \| undefined`
`challengeId`	`string \| undefined`

Response

Field	Type	Description
`loginMethods`	`object[]`	See below

loginMethods[] item fields:

Field	Type	Description
`method`	`“EmailOtp”	“Passkey”
`priority`	`number`

Errors

Status	Description
400	3: User identifier and type are required.
403	0: Token Validation Failed 2: Invalid user identifier. 4: No login methods available. Please use account recovery.
500	0: An unknown error occurred.
503	1: This feature is disabled.

`postLogin`

POST /v1/login

Authenticates a user.

Usage

import { fetchApi } from 'rozod';
import { postLogin } from 'rozod/endpoints/authv1';

const data = await fetchApi(postLogin, {
  body: { /* ... */ }
});

Request Body

Field	Type	Description
`ctype`	`“Email”	“Username”
`cvalue`	`string`
`password`	`string`
`userId`	`number`
`securityQuestionSessionId`	`string`
`securityQuestionRedemptionToken`	`string`
`secureAuthenticationIntent`	`object`	See below
`accountBlob`	`string`
`accountLinkParameters`	`object`	See below
`captchaId`	`string`
`captchaToken`	`string`
`captchaProvider`	`string`
`challengeId`	`string`

secureAuthenticationIntent fields:

Field	Type	Description
`clientPublicKey`	`string`
`clientEpochTimestamp`	`number`
`saiSignature`	`string`
`serverNonce`	`string`

accountLinkParameters fields:

Field	Type	Description
`LinkingPlatform`	`“Invalid”	“Xbox”

Response

Field	Type	Description
`user`	`object`	See below
`twoStepVerificationData`	`object`	See below
`identityVerificationLoginTicket`	`string`
`isBanned`	`boolean`
`accountBlob`	`string`
`shouldUpdateEmail`	`boolean`
`recoveryEmail`	`string`
`passkeyRegistrationSucceeded`	`boolean`
`shouldAutoLoginFromRecovery`	`boolean`
`shouldPrompt2svRemoval`	`boolean`
`shouldPromptPasskeyAddition`	`boolean`
`shouldPromptCredentialInvalidation`	`boolean`

user fields:

Field	Type	Description
`id`	`number`
`name`	`string`
`displayName`	`string`

twoStepVerificationData fields:

Field	Type	Description
`mediaType`	`“Email”	“SMS”
`ticket`	`string`

Errors

Status	Description
400	0: An unexpected error occurred. 3: Username and Password are required. Please try again. 8: Login with received credential type is not supported.
403	0: Token Validation Failed 1: Incorrect username or password. Please try again. 2: You must pass the robot test before logging in. 4: Account has been locked. Please request a password reset. 5: Unable to login. Please use Social Network sign on. 6: Account issue. Please contact Support. 9: Unable to login with provided credentials. Default login is required. 10: Received credentials are unverified. 12: Existing login session found. Please log out first. 14: The account is unable to log in. Please log in to the LuoBu app. 15: Too many attempts. Please wait a bit. 27: The account is unable to login. Please log in with the VNG app.
429	7: Too many attempts. Please wait a bit.
503	11: Service unavailable. Please try again.

`postLoginLinked`

POST /v1/login/linked

Endpoint for logging in a user, specifically for linked

Usage

import { fetchApi } from 'rozod';
import { postLoginLinked } from 'rozod/endpoints/authv1';

const data = await fetchApi(postLoginLinked, {
  body: { /* ... */ }
});

Request Body

Field	Type	Description
`ctype`	`“Email”	“Username”
`cvalue`	`string`
`password`	`string`
`userId`	`number`
`securityQuestionSessionId`	`string`
`securityQuestionRedemptionToken`	`string`
`secureAuthenticationIntent`	`object`	See below
`accountBlob`	`string`
`accountLinkParameters`	`object`	See below
`captchaId`	`string`
`captchaToken`	`string`
`captchaProvider`	`string`
`challengeId`	`string`

secureAuthenticationIntent fields:

Field	Type	Description
`clientPublicKey`	`string`
`clientEpochTimestamp`	`number`
`saiSignature`	`string`
`serverNonce`	`string`

accountLinkParameters fields:

Field	Type	Description
`LinkingPlatform`	`“Invalid”	“Xbox”

Response

Field	Type	Description
`user`	`object`	See below
`twoStepVerificationData`	`object`	See below
`identityVerificationLoginTicket`	`string`
`isBanned`	`boolean`
`accountBlob`	`string`
`shouldUpdateEmail`	`boolean`
`recoveryEmail`	`string`
`passkeyRegistrationSucceeded`	`boolean`
`shouldAutoLoginFromRecovery`	`boolean`
`shouldPrompt2svRemoval`	`boolean`
`shouldPromptPasskeyAddition`	`boolean`
`shouldPromptCredentialInvalidation`	`boolean`

user fields:

Field	Type	Description
`id`	`number`
`name`	`string`
`displayName`	`string`

twoStepVerificationData fields:

Field	Type	Description
`mediaType`	`“Email”	“SMS”
`ticket`	`string`

Errors

Status	Description
400	0: An unexpected error occurred. 3: Username and Password are required. Please try again. 8: Login with received credential type is not supported.
403	0: Token Validation Failed 1: Incorrect username or password. Please try again. 2: You must pass the robot test before logging in. 4: Account has been locked. Please request a password reset. 5: Unable to login. Please use Social Network sign on. 6: Account issue. Please contact Support. 9: Unable to login with provided credentials. Default login is required. 10: Received credentials are unverified. 12: Existing login session found. Please log out first. 14: The account is unable to log in. Please log in to the LuoBu app. 15: Too many attempts. Please wait a bit. 27: The account is unable to login. Please log in with the VNG app. 43: This account is not eligible for this platform.
429	7: Too many attempts. Please wait a bit.
503	11: Service unavailable. Please try again.

`postLogout`

POST /v1/logout

Destroys the current authentication session.

Usage

import { fetchApi } from 'rozod';
import { postLogout } from 'rozod/endpoints/authv1';

const data = await fetchApi(postLogout, undefined);

Response

Type: unknown

Errors

Status	Description
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed

`postLogoutfromallsessionsandreauthenticate`

POST /v1/logoutfromallsessionsandreauthenticate

Logs out user from all other sessions.

Usage

import { fetchApi } from 'rozod';
import { postLogoutfromallsessionsandreauthenticate } from 'rozod/endpoints/authv1';

const data = await fetchApi(postLogoutfromallsessionsandreauthenticate, {
  body: { /* ... */ }
});

Request Body

Field	Type	Description
`SecureAuthenticationIntent`	`object`	See below

SecureAuthenticationIntent fields:

Field	Type	Description
`clientPublicKey`	`string`
`clientEpochTimestamp`	`number`
`saiSignature`	`string`
`serverNonce`	`string`

Response

Type: unknown

Errors

Status	Description
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed

`getMetadata`

GET /v1/metadata

Get the metadata

Usage

import { fetchApi } from 'rozod';
import { getMetadata } from 'rozod/endpoints/authv1';

const data = await fetchApi(getMetadata, undefined);

Response

Field	Type	Description
`isUpdateUsernameEnabled`	`boolean`
`ftuxAvatarAssetMap`	`string`
`IsEmailUpsellAtLogoutEnabled`	`boolean`
`ShouldFetchEmailUpsellIXPValuesAtLogout`	`boolean`
`IsAccountRecoveryPromptEnabled`	`boolean`
`IsContactMethodRequiredAtSignup`	`boolean`
`IsUserAgreementsSignupIntegrationEnabled`	`boolean`
`IsPasswordRequiredForUsernameChange`	`boolean`
`IsPasskeyFeatureEnabled`	`boolean`
`IsAltBrowserTracker`	`boolean`
`IsLoginRedirectPageEnabled`	`boolean`

`postPasskeyDeletecredentialbatch`

POST /v1/passkey/DeleteCredentialBatch

Disables a batch of credentials for the specified user.

Usage

import { fetchApi } from 'rozod';
import { postPasskeyDeletecredentialbatch } from 'rozod/endpoints/authv1';

const data = await fetchApi(postPasskeyDeletecredentialbatch, {
  body: { /* ... */ }
});

Request Body

Field	Type	Description
`credentialIDs`	`string[]`
`credentialNicknames`	`string[]`

Response

Type: unknown

Errors

Status	Description
400	3: Invalid security key nickname.
401	0: Authorization has been denied for this request. 0: An unknown error occurred with the request.
403	0: Token Validation Failed
503	2: Feature disabled.

`postPasskeyFinishArPreauthRegistration`

POST /v1/passkey/finish-ar-preauth-registration

Finishes account recovery pre-auth passkey registration by validating the recovery session,

Usage

import { fetchApi } from 'rozod';
import { postPasskeyFinishArPreauthRegistration } from 'rozod/endpoints/authv1';

const data = await fetchApi(postPasskeyFinishArPreauthRegistration, {
  body: { /* ... */ }
});

Request Body

Field	Type	Description
`recoverySession`	`string`
`passkeySessionId`	`string`
`passkeyRegistrationResponse`	`string`
`userId`	`number`
`isPostRecovery`	`boolean`
`source`	`string`

Response

Type: unknown

Errors

Status	Description
400	0: An unknown error occurred with the request.
401	0: An unknown error occurred with the request.
403	0: Token Validation Failed 1: Reached limit of pass keys registered.
500	0: An unknown error occurred with the request.
503	2: Feature disabled.

`postPasskeyFinishPreauthRegistration`

POST /v1/passkey/finish-preauth-registration

Usage

import { fetchApi } from 'rozod';
import { postPasskeyFinishPreauthRegistration } from 'rozod/endpoints/authv1';

const data = await fetchApi(postPasskeyFinishPreauthRegistration, {
  body: { /* ... */ }
});

Request Body

Field	Type	Description
`sessionId`	`string`
`registrationResponse`	`string`
`source`	`string`

Response

Type: unknown

Errors

Status	Description
400	0: An unknown error occurred with the request.
401	0: Authorization has been denied for this request. 0: An unknown error occurred with the request.
403	0: Token Validation Failed 1: Reached limit of pass keys registered.
500	0: An unknown error occurred with the request.
503	2: Feature disabled.

`postPasskeyFinishregistration`

POST /v1/passkey/FinishRegistration

Complete Passkey registration by providing credential creation options.

Usage

import { fetchApi } from 'rozod';
import { postPasskeyFinishregistration } from 'rozod/endpoints/authv1';

const data = await fetchApi(postPasskeyFinishregistration, {
  body: { /* ... */ }
});

Request Body

Field	Type	Description
`sessionId`	`string`
`credentialNickname`	`string`
`attestationResponse`	`string`
`source`	`string`

Response

Type: unknown

Errors

Status	Description
400	0: An unknown error occurred with the request. 3: Invalid security key nickname.
401	0: Authorization has been denied for this request. 0: An unknown error occurred with the request.
403	0: Token Validation Failed 3: Invalid security key nickname.
503	2: Feature disabled.

`postPasskeyListcredentials`

POST /v1/passkey/ListCredentials

List a user’s registered passkeys.

Usage

import { fetchApi } from 'rozod';
import { postPasskeyListcredentials } from 'rozod/endpoints/authv1';

const data = await fetchApi(postPasskeyListcredentials, {
  body: { /* ... */ }
});

Request Body

Field	Type	Description
`all`	`boolean`

Response

Field	Type	Description
`credentials`	`object[]`	See below

credentials[] item fields:

Field	Type	Description
`nickname`	`string`
`credentialID`	`string`

Errors

Status	Description
401	0: Authorization has been denied for this request. 0: An unknown error occurred with the request.
403	0: Token Validation Failed
503	2: Feature disabled.

`postPasskeyRenamecredential`

POST /v1/passkey/RenameCredential

Rename a credential for the specified user.

Usage

import { fetchApi } from 'rozod';
import { postPasskeyRenamecredential } from 'rozod/endpoints/authv1';

const data = await fetchApi(postPasskeyRenamecredential, {
  body: { /* ... */ }
});

Request Body

Field	Type	Description
`credentialID`	`string`
`newNickname`	`string`

Response

Type: unknown

Errors

Status	Description
400	3: Invalid security key nickname. 7: Invalid passkey ID.
401	0: Authorization has been denied for this request. 0: An unknown error occurred with the request.
403	0: Token Validation Failed 3: Invalid security key nickname.
503	2: Feature disabled.

`postPasskeyStartAuthenticationByUser`

POST /v1/passkey/start-authentication-by-user

Initializes passkey authentication for the user(s) corresponding to the identifier provided.

Usage

import { fetchApi } from 'rozod';
import { postPasskeyStartAuthenticationByUser } from 'rozod/endpoints/authv1';

const data = await fetchApi(postPasskeyStartAuthenticationByUser, {
  body: { /* ... */ }
});

Request Body

Field	Type	Description
`ctype`	`0	1
`cvalue`	`string`

Response

Field	Type	Description
`authenticationOptions`	`string`
`sessionId`	`string`

Errors

Status	Description
400	5: User identifier and type are required. 6: Multi-user passkey authentication is not supported for this credential type.
403	0: Token Validation Failed 4: No passkeys registered for any users found.
503	2: Feature disabled.

`postPasskeyStartPreauthRegistration`

POST /v1/passkey/start-preauth-registration

Initiates Passkey preauthenticated registration by providing credential creation options.

Usage

import { fetchApi } from 'rozod';
import { postPasskeyStartPreauthRegistration } from 'rozod/endpoints/authv1';

const data = await fetchApi(postPasskeyStartPreauthRegistration, {
  body: { /* ... */ }
});

Request Body

Field	Type	Description
`username`	`string`

Response

Field	Type	Description
`creationOptions`	`string`
`sessionId`	`string`

Errors

Status	Description
403	0: Token Validation Failed
503	2: Feature disabled.

`postPasskeyStartauthentication`

POST /v1/passkey/StartAuthentication

Provides a challenge for the Passkey to authenticate.

Usage

import { fetchApi } from 'rozod';
import { postPasskeyStartauthentication } from 'rozod/endpoints/authv1';

const data = await fetchApi(postPasskeyStartauthentication, undefined);

Response

Field	Type	Description
`authenticationOptions`	`string`
`sessionId`	`string`

Errors

Status	Description
403	0: Token Validation Failed
503	2: Feature disabled.

`postPasskeyStartregistration`

POST /v1/passkey/StartRegistration

Initiates Passkey registration by providing credential creation options.

Usage

import { fetchApi } from 'rozod';
import { postPasskeyStartregistration } from 'rozod/endpoints/authv1';

const data = await fetchApi(postPasskeyStartregistration, {
  flow: /* string? */,
  body: { /* ... */ }
});

Parameters

Name	Type	Required	Description
`flow`	`string?`	No

Request Body

Field	Type	Description
`isSilentUpgrade`	`boolean`

Response

Field	Type	Description
`creationOptions`	`string`
`sessionId`	`string`

Errors

Status	Description
401	0: Authorization has been denied for this request. 0: An unknown error occurred with the request.
403	0: Token Validation Failed 1: Reached limit of pass keys registered.
503	2: Feature disabled.

`getPasskeySuEligibility`

GET /v1/passkey/su-eligibility

Checks whether the authenticated user is eligible for silent passkey upgrade.

Usage

import { fetchApi } from 'rozod';
import { getPasskeySuEligibility } from 'rozod/endpoints/authv1';

const data = await fetchApi(getPasskeySuEligibility, undefined);

Response

Field	Type	Description
`suEligibility`	`boolean`

Errors

Status	Description
401	0: Authorization has been denied for this request. 0: An unknown error occurred with the request.
503	2: Feature disabled.

`getPasswordsValidate`

GET /v1/passwords/validate

Endpoint for checking if a password is valid.

Usage

import { fetchApi } from 'rozod';
import { getPasswordsValidate } from 'rozod/endpoints/authv1';

const data = await fetchApi(getPasswordsValidate, {
  Username: /* string */,
  Password: /* string */
});

Parameters

Name	Type	Required	Description
`Username`	`string`	Yes
`Password`	`string`	Yes

Response

Field	Type	Description
`code`	`“ValidPassword”	“WeakPasswordError”
`message`	`string`

Errors

Status	Description
400	1: Valid Username and Password are required. Please try again.

`postPasswordsValidate`

POST /v1/passwords/validate

Endpoint for checking if a password is valid.

Usage

import { fetchApi } from 'rozod';
import { postPasswordsValidate } from 'rozod/endpoints/authv1';

const data = await fetchApi(postPasswordsValidate, {
  body: { /* ... */ }
});

Request Body

Field	Type	Description
`username`	`string`
`password`	`string`

Response

Field	Type	Description
`code`	`“ValidPassword”	“WeakPasswordError”
`message`	`string`

Errors

Status	Description
400	1: Valid Username and Password are required. Please try again.
403	0: Token Validation Failed

`getRecoveryMetadata`

GET /v1/recovery/metadata

Get metadata for forgot endpoints

Usage

import { fetchApi } from 'rozod';
import { getRecoveryMetadata } from 'rozod/endpoints/authv1';

const data = await fetchApi(getRecoveryMetadata, undefined);

Response

Field	Type	Description
`isOnPhone`	`boolean`
`codeLength`	`number`
`isPhoneFeatureEnabledForUsername`	`boolean`
`isPhoneFeatureEnabledForPassword`	`boolean`
`isBedev2CaptchaEnabledForPasswordReset`	`boolean`
`isUsernameRecoveryDeprecated`	`boolean`

Errors

Status	Description
503	7: The Roblox WeChat API is currently unavailable.

`getRevertAccount`

GET /v1/revert/account

Get Revert Account ticket info

Usage

import { fetchApi } from 'rozod';
import { getRevertAccount } from 'rozod/endpoints/authv1';

const data = await fetchApi(getRevertAccount, {
  ticket: /* string */
});

Parameters

Name	Type	Required	Description
`ticket`	`string`	Yes	Ticket Guid to revert account.

Response

Field	Type	Description
`isTwoStepVerificationEnabled`	`boolean`
`isEmailVerified`	`boolean`
`isEmailChanged`	`boolean`
`isPhoneVerified`	`boolean`
`userId`	`number`
`username`	`string`
`ticket`	`string`

Errors

Status	Description
400	2: The account revert ticket is not valid
403	13: Revert links are disabled for users in the Enhanced Protection Program.
503	1: This feature is disabled

`postRevertAccount`

POST /v1/revert/account

Submit Revert Account Request

Usage

import { fetchApi } from 'rozod';
import { postRevertAccount } from 'rozod/endpoints/authv1';

const data = await fetchApi(postRevertAccount, {
  body: { /* ... */ }
});

Request Body

Field	Type	Description
`UserId`	`number`
`NewPassword`	`string`
`NewPasswordRepeated`	`string`
`Ticket`	`string`
`TwoStepVerificationChallengeId`	`string`
`TwoStepVerificationToken`	`string`

Response

Field	Type	Description
`user`	`object`	See below
`twoStepVerificationData`	`object`	See below
`identityVerificationLoginTicket`	`string`
`isBanned`	`boolean`
`accountBlob`	`string`
`shouldUpdateEmail`	`boolean`
`recoveryEmail`	`string`
`passkeyRegistrationSucceeded`	`boolean`
`shouldAutoLoginFromRecovery`	`boolean`
`shouldPrompt2svRemoval`	`boolean`
`shouldPromptPasskeyAddition`	`boolean`
`shouldPromptCredentialInvalidation`	`boolean`

user fields:

Field	Type	Description
`id`	`number`
`name`	`string`
`displayName`	`string`

twoStepVerificationData fields:

Field	Type	Description
`mediaType`	`“Email”	“SMS”
`ticket`	`string`

Errors

Status	Description
400	2: The account revert ticket is not valid 3: Password is not valid 4: Passwords do not match 5: Password cannot be used 8: The account security ticket is expired.
403	0: Token Validation Failed
503	0: Unknown 1: This feature is disabled

`postRevertInvalidateTickets`

POST /v1/revert/invalidate-tickets

Invalidates all account security tickets for the authenticated user.

Usage

import { fetchApi } from 'rozod';
import { postRevertInvalidateTickets } from 'rozod/endpoints/authv1';

const data = await fetchApi(postRevertInvalidateTickets, undefined);

Response

Type: unknown

Errors

Status	Description
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed
503	1: This feature is disabled

`postSessionRefresh`

POST /v1/session/refresh

Logs out user from the current session and create a new one.

Usage

import { fetchApi } from 'rozod';
import { postSessionRefresh } from 'rozod/endpoints/authv1';

const data = await fetchApi(postSessionRefresh, undefined);

Response

Type: unknown

Errors

Status	Description
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed

`postSignup`

POST /v1/signup

Endpoint for signing up a new user

Usage

import { fetchApi } from 'rozod';
import { postSignup } from 'rozod/endpoints/authv1';

const data = await fetchApi(postSignup, {
  body: { /* ... */ }
});

Request Body

Field	Type	Description
`username`	`string`
`password`	`string`
`gender`	`“Unknown”	“Male”
`birthday`	`string`
`displayName`	`string`
`isTosAgreementBoxChecked`	`boolean`
`signupType`	`“Regular”	“Express”`
`email`	`string`
`locale`	`string`
`assetIds`	`number[]`
`bodyColorId`	`number`
`bodyTypeScale`	`number`
`headScale`	`number`
`heightScale`	`number`
`widthScale`	`number`
`proportionScale`	`number`
`referralData`	`object`	See below
`agreementIds`	`string[]`
`identityVerificationResultToken`	`string`
`secureAuthenticationIntent`	`object`	See below
`otpSession`	`object`	See below
`dataToken`	`string`
`accountBlob`	`string`
`passkeySessionId`	`string`
`passkeyRegistrationResponse`	`string`
`accountLinkParameters`	`object`	See below
`auditSystemContent`	`object`	See below
`captchaId`	`string`
`captchaToken`	`string`
`captchaProvider`	`string`
`challengeId`	`string`

referralData fields:

Field	Type	Description
`acquisitionTime`	`string`
`acquisitionReferrer`	`string`
`medium`	`string`
`source`	`string`
`campaign`	`string`
`adGroup`	`string`
`keyword`	`string`
`matchType`	`string`
`sendInfo`	`boolean`
`requestSessionId`	`string`
`offerId`	`string`

secureAuthenticationIntent fields:

Field	Type	Description
`clientPublicKey`	`string`
`clientEpochTimestamp`	`number`
`saiSignature`	`string`
`serverNonce`	`string`

otpSession fields:

Field	Type	Description
`otpSessionToken`	`string`
`otpContactType`	`“Unset”	“Email”`

accountLinkParameters fields:

Field	Type	Description
`LinkingPlatform`	`“Invalid”	“Xbox”

auditSystemContent fields:

Field	Type	Description
`capturedAuditContent`	`object`	See below
`additionalAuditContent`	`string`

capturedAuditContent fields:

Field	Type	Description
`translationKey`	`string`
`translationNamespace`	`string`
`translatedSourceString`	`string`
`parameters`	`string`

Response

Field	Type	Description
`userId`	`number`
`starterPlaceId`	`number`
`returnUrl`	`string`
`accountBlob`	`string`

Errors

Status	Description
400	Bad request 16: User agreement ids are null. 21: Empty account switch blob required
403	0: Token Validation Failed 2: Captcha Failed. 4: Invalid Birthday. 5: Invalid Username. 6: Username already taken. 7: Invalid Password. 8: Password and Username are same. 9: Password is too simple. 10: Email is invalid. 11: Asset is invalid. 12: Too many attempts. Please wait a bit. 17: One time Passcode session was not valid 22: Maximum logged in accounts limit reached.
429	3: Too many attempts. Please wait a bit.
500	Internal server error 15: Insert acceptances failed. 27: Pre-auth passkey registration failed
503	Service unavailable

`postSignupLinked`

POST /v1/signup/linked

Endpoint for signing up a new user through linked authentication.

Usage

import { fetchApi } from 'rozod';
import { postSignupLinked } from 'rozod/endpoints/authv1';

const data = await fetchApi(postSignupLinked, {
  body: { /* ... */ }
});

Request Body

Field	Type	Description
`username`	`string`
`password`	`string`
`gender`	`“Unknown”	“Male”
`birthday`	`string`
`displayName`	`string`
`isTosAgreementBoxChecked`	`boolean`
`signupType`	`“Regular”	“Express”`
`email`	`string`
`locale`	`string`
`assetIds`	`number[]`
`bodyColorId`	`number`
`bodyTypeScale`	`number`
`headScale`	`number`
`heightScale`	`number`
`widthScale`	`number`
`proportionScale`	`number`
`referralData`	`object`	See below
`agreementIds`	`string[]`
`identityVerificationResultToken`	`string`
`secureAuthenticationIntent`	`object`	See below
`otpSession`	`object`	See below
`dataToken`	`string`
`accountBlob`	`string`
`passkeySessionId`	`string`
`passkeyRegistrationResponse`	`string`
`accountLinkParameters`	`object`	See below
`auditSystemContent`	`object`	See below
`captchaId`	`string`
`captchaToken`	`string`
`captchaProvider`	`string`
`challengeId`	`string`

referralData fields:

Field	Type	Description
`acquisitionTime`	`string`
`acquisitionReferrer`	`string`
`medium`	`string`
`source`	`string`
`campaign`	`string`
`adGroup`	`string`
`keyword`	`string`
`matchType`	`string`
`sendInfo`	`boolean`
`requestSessionId`	`string`
`offerId`	`string`

secureAuthenticationIntent fields:

Field	Type	Description
`clientPublicKey`	`string`
`clientEpochTimestamp`	`number`
`saiSignature`	`string`
`serverNonce`	`string`

otpSession fields:

Field	Type	Description
`otpSessionToken`	`string`
`otpContactType`	`“Unset”	“Email”`

accountLinkParameters fields:

Field	Type	Description
`LinkingPlatform`	`“Invalid”	“Xbox”

auditSystemContent fields:

Field	Type	Description
`capturedAuditContent`	`object`	See below
`additionalAuditContent`	`string`

capturedAuditContent fields:

Field	Type	Description
`translationKey`	`string`
`translationNamespace`	`string`
`translatedSourceString`	`string`
`parameters`	`string`

Response

Field	Type	Description
`userId`	`number`
`starterPlaceId`	`number`
`returnUrl`	`string`
`accountBlob`	`string`

Errors

Status	Description
400	Bad request 16: User agreement ids are null. 21: Empty account switch blob required
403	0: Token Validation Failed 2: Captcha Failed. 4: Invalid Birthday. 5: Invalid Username. 6: Username already taken. 7: Invalid Password. 8: Password and Username are same. 9: Password is too simple. 10: Email is invalid. 11: Asset is invalid. 12: Too many attempts. Please wait a bit. 17: One time Passcode session was not valid 22: Maximum logged in accounts limit reached. 29: Account Linking already exists on this account 30: Account Linking required but failed
429	3: Too many attempts. Please wait a bit.
500	Internal server error 15: Insert acceptances failed. 27: Pre-auth passkey registration failed 30: Account Linking required but failed
503	30: Account Linking required but failed

`postSocialProviderDisconnect`

POST /v1/social/:provider/disconnect

Removes the given social authentication method from current Roblox user if it is connected.

Usage

import { fetchApi } from 'rozod';
import { postSocialProviderDisconnect } from 'rozod/endpoints/authv1';

const data = await fetchApi(postSocialProviderDisconnect, {
  provider: /* string */,
  body: { /* ... */ }
});

Parameters

Name	Type	Required	Description
`provider`	`string`	Yes	The social authentication provider, e.g. Facebook

Request Body

Field	Type	Description
`Password`	`string`

Response

Type: unknown

Errors

Status	Description
400	Bad request 2: Unsupported social provider type.
401	0: Authorization has been denied for this request.
403	Forbidden 0: Token Validation Failed 3: Cannot disconnect the only authentication method. Password on account is required. 4: The password provided is invalid.
500	Internal server error

`getSocialConnectedProviders`

GET /v1/social/connected-providers

Get social network user information if the given social auth method is connected to current user.

Usage

import { fetchApi } from 'rozod';
import { getSocialConnectedProviders } from 'rozod/endpoints/authv1';

const data = await fetchApi(getSocialConnectedProviders, undefined);

Response

Field	Type	Description
`providers`	`object[]`	See below

providers[] item fields:

Field	Type	Description
`provider`	`string`
`identifier`	`string`

Errors

Status	Description
401	0: Authorization has been denied for this request.

`postUserPasswordsChange`

POST /v1/user/passwords/change

Changes the password for the authenticated user.

Usage

import { fetchApi } from 'rozod';
import { postUserPasswordsChange } from 'rozod/endpoints/authv1';

const data = await fetchApi(postUserPasswordsChange, {
  body: { /* ... */ }
});

Request Body

Field	Type	Description
`currentPassword`	`string`
`newPassword`	`string`
`secureAuthenticationIntent`	`object`	See below

secureAuthenticationIntent fields:

Field	Type	Description
`clientPublicKey`	`string`
`clientEpochTimestamp`	`number`
`saiSignature`	`string`
`serverNonce`	`string`

Response

Type: unknown

Errors

Status	Description
400	Roblox.Web.Authentication.Passwords.PasswordResponseCodes.InvalidCurrentPassword OR Roblox.Web.Authentication.Passwords.PasswordResponseCodes.InvalidPassword
401	0: Authorization has been denied for this request.
403	Roblox.Web.Authentication.Passwords.PasswordResponseCodes.PinLocked 0: Token Validation Failed
429	Roblox.Web.Authentication.Passwords.PasswordResponseCodes.Flooded

`postUsername`

POST /v1/username

Change the user’s username

Usage

import { fetchApi } from 'rozod';
import { postUsername } from 'rozod/endpoints/authv1';

const data = await fetchApi(postUsername, {
  body: { /* ... */ }
});

Request Body

Field	Type	Description
`username`	`string`
`password`	`string`

Response

Type: unknown

Errors

Status	Description
400	5: You don't have enough Robux to change your username. 10: This username is already in use 11: Username not appropriate for Roblox 12: Usernames can be 3 to 20 characters long 13: Usernames can’t start or end with _ and can have at most one _ 14: Only a-z, A-Z, 0-9, and _ are allowed 15: Username is null 16: Username might contain private information 17: This username is not available 18: Username is same as current
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed 1: PIN is locked. 2: A verified email is missing 3: Your password is incorrect. 100: Unknown birthday
500	0: An unknown error occured. 5: You don't have enough Robux to change your username.
503	4: The feature is currently not available. Please try again later.

`getUsernameChangePrice`

GET /v1/username/change/price

Get the current price for a username change

Usage

import { fetchApi } from 'rozod';
import { getUsernameChangePrice } from 'rozod/endpoints/authv1';

const data = await fetchApi(getUsernameChangePrice, undefined);

Response

Field	Type	Description
`priceInRobux`	`number`
`basePriceInRobux`	`number`

Errors

Status	Description
401	0: Authorization has been denied for this request.

`getUsernames`

GET /v1/usernames

Gets a list of existing usernames on Roblox based on the query parameters

Usage

import { fetchApi } from 'rozod';
import { getUsernames } from 'rozod/endpoints/authv1';

const data = await fetchApi(getUsernames, {
  username: /* string */
});

Parameters

Name	Type	Required	Description
`username`	`string`	Yes	The username

Response

Field	Type	Description
`usernames`	`string[]`

`postUsernamesRecover`

POST /v1/usernames/recover

Sends an email of all accounts belonging to an email

Usage

import { fetchApi } from 'rozod';
import { postUsernamesRecover } from 'rozod/endpoints/authv1';

const data = await fetchApi(postUsernamesRecover, {
  body: { /* ... */ }
});

Request Body

Field	Type	Description
`targetType`	`“Email”	“PhoneNumber”
`target`	`string`

Response

Field	Type	Description
`transmissionType`	`0	1`

Errors

Status	Description
400	20: Invalid Email 21: Invalid Phone 23: No Account Found
403	0: Token Validation Failed 11: Too many attempts. Please wait a bit.
500	0: An unexpected error occurred.

`getUsernamesValidate`

GET /v1/usernames/validate

Checks if a username is valid.

Usage

import { fetchApi } from 'rozod';
import { getUsernamesValidate } from 'rozod/endpoints/authv1';

const data = await fetchApi(getUsernamesValidate, {
  Username: /* string */,
  Birthday: /* string */
});

Parameters

Name	Type	Required	Description
`Username`	`string`	Yes
`Birthday`	`string`	Yes

Response

Field	Type	Description
`code`	`“ValidUsername”	“AlreadyInUseError”
`message`	`string`

Errors

Status	Description
400	1: A valid username is required. 2: A valid birthday or authenticated user is required.

`postUsernamesValidate`

POST /v1/usernames/validate

Checks if a username is valid.

Usage

import { fetchApi } from 'rozod';
import { postUsernamesValidate } from 'rozod/endpoints/authv1';

const data = await fetchApi(postUsernamesValidate, {
  body: { /* ... */ }
});

Request Body

Field	Type	Description
`username`	`string`
`birthday`	`string`
`context`	`0	1

Response

Field	Type	Description
`code`	`“ValidUsername”	“AlreadyInUseError”
`message`	`string`

Errors

Status	Description
400	1: A valid username is required. 2: A valid birthday or authenticated user is required.
403	0: Token Validation Failed

`getValidatorsEmail`

GET /v1/validators/email

Tries to check if an email is valid

Usage

import { fetchApi } from 'rozod';
import { getValidatorsEmail } from 'rozod/endpoints/authv1';

const data = await fetchApi(getValidatorsEmail, {
  Email: /* string */
});

Parameters

Name	Type	Required	Description
`Email`	`string`	Yes

Response

Field	Type	Description
`isEmailValid`	`boolean`

`getValidatorsRecommendedusernamefromdisplayname`

GET /v1/validators/recommendedUsernameFromDisplayName

Validates the given display name, and if valid, will convert it to a valid username and return suggested username(s) if available.

Usage

import { fetchApi } from 'rozod';
import { getValidatorsRecommendedusernamefromdisplayname } from 'rozod/endpoints/authv1';

const data = await fetchApi(getValidatorsRecommendedusernamefromdisplayname, {
  DisplayName: /* string */,
  BirthDay: /* string */
});

Parameters

Name	Type	Required	Description
`DisplayName`	`string`	Yes
`BirthDay`	`string`	Yes

Response

Field	Type	Description
`didGenerateNewUsername`	`boolean`
`suggestedUsernames`	`string[]`

`postValidatorsRecommendedusernamefromdisplayname`

POST /v1/validators/recommendedUsernameFromDisplayName

Validates the given display name, and if valid, will convert it to a valid username and return suggested username(s) if available.

Usage

import { fetchApi } from 'rozod';
import { postValidatorsRecommendedusernamefromdisplayname } from 'rozod/endpoints/authv1';

const data = await fetchApi(postValidatorsRecommendedusernamefromdisplayname, {
  body: { /* ... */ }
});

Request Body

Field	Type	Description
`displayName`	`string`
`birthday`	`string`

Response

Field	Type	Description
`didGenerateNewUsername`	`boolean`
`suggestedUsernames`	`string[]`

Errors

Status	Description
403	0: Token Validation Failed

`getValidatorsUsername`

GET /v1/validators/username

Tries to get a valid username if the current username is taken

Usage

import { fetchApi } from 'rozod';
import { getValidatorsUsername } from 'rozod/endpoints/authv1';

const data = await fetchApi(getValidatorsUsername, {
  Username: /* string */,
  BirthDay: /* string */
});

Parameters

Name	Type	Required	Description
`Username`	`string`	Yes
`BirthDay`	`string`	Yes

Response

Field	Type	Description
`didGenerateNewUsername`	`boolean`
`suggestedUsernames`	`string[]`

`postValidatorsUsername`

POST /v1/validators/username

Tries to get a valid username if the current username is taken

Usage

import { fetchApi } from 'rozod';
import { postValidatorsUsername } from 'rozod/endpoints/authv1';

const data = await fetchApi(postValidatorsUsername, {
  body: { /* ... */ }
});

Request Body

Field	Type	Description
`username`	`string`
`birthday`	`string`

Response

Field	Type	Description
`didGenerateNewUsername`	`boolean`
`suggestedUsernames`	`string[]`

Errors

Status	Description
403	0: Token Validation Failed

`getXboxConnection`

GET /v1/xbox/connection

Check if the current user has an Xbox connected.

Usage

import { fetchApi } from 'rozod';
import { getXboxConnection } from 'rozod/endpoints/authv1';

const data = await fetchApi(getXboxConnection, undefined);

Response

Field	Type	Description
`hasConnectedXboxAccount`	`boolean`
`gamertag`	`string`

Errors

Status	Description
401	0: Authorization has been denied for this request.

`postXboxDisconnect`

POST /v1/xbox/disconnect

Unlink the current ROBLOX account from the Xbox live account.

Usage

import { fetchApi } from 'rozod';
import { postXboxDisconnect } from 'rozod/endpoints/authv1';

const data = await fetchApi(postXboxDisconnect, undefined);

Response

Field	Type	Description
`success`	`boolean`

Errors

Status	Description
401	0: Authorization has been denied for this request.
403	Forbidden 0: Token Validation Failed

`getXboxGetLoginConsecutiveDays`

GET /v1/xbox/get-login-consecutive-days

Get the consecutive days the xbox user has been logged in.

Usage

import { fetchApi } from 'rozod';
import { getXboxGetLoginConsecutiveDays } from 'rozod/endpoints/authv1';

const data = await fetchApi(getXboxGetLoginConsecutiveDays, undefined);

Response

Field	Type	Description
`count`	`number`

Errors

Status	Description
400	36: Invalid Xbox Live Account
401	0: Authorization has been denied for this request.

`postXboxTranslate`

POST /v1/xbox/translate

Translate the xbox user to roblox user.

Usage

import { fetchApi } from 'rozod';
import { postXboxTranslate } from 'rozod/endpoints/authv1';

const data = await fetchApi(postXboxTranslate, {
  body: { /* ... */ }
});

Request Body

Field	Type	Description
`ids`	`string[]`

Response

Field	Type	Description
`Users`	`object[]`	See below

Users[] item fields:

Field	Type	Description
`Id`	`string`
`UserId`	`number`
`Username`	`string`

Errors

Status	Description
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed