Module: client/apis/AuthAPI

Table of contents

Classes

• default

Type aliases

• ChangeUserPassword
• ChangeUserPasswordOptions
• ChangeUsername
• ChangeUsernameOptions
• GetAuthMetaData
• GetAuthTicket
• GetCredentialsVerificationStatus
• GetCredentialsVerificationStatusOptions
• GetCurrentPasswordStatus
• GetExistingUsernames
• GetExistingUsernamesOptions
• GetMetaData
• GetPasswordResetMetaData
• GetPasswordResetMetaDataOptions
• GetRecoveryMetaData
• GetSAMLMetaData
• GetTwoStepVerificationMetaData
• Login
• LoginOptions
• Logout
• RecoverUsernames
• RecoverUsernamesOptions
• RequestTwoStepVerification
• ResendTwoStepVerification
• ResendTwoStepVerificationOptions
• ResetPassword
• ResetPasswordOptions
• RevertAccount
• RevertAccountInfo
• RevertAccountInfoOptions
• RevertAccountOptions
• SAMLRequest
• SendCredentialsVerificationMessage
• SendCredentialsVerificationMessageOptions
• SendPasswordReset
• SendPasswordResetOptions
• SignUp
• SignUpOptions
• ValidatePassword
• ValidatePasswordOptions
• ValidateUsername
• ValidateUsernameOptions
• VerifyPasswordReset
• VerifyPasswordResetOptions
• VerifyTwoStepVerification
• VerifyTwoStepVerificationOptions

Type aliases

ChangeUserPassword

Ƭ ChangeUserPassword: unknown

Defined in: client/apis/AuthAPI.ts:108

---

ChangeUserPasswordOptions

Ƭ ChangeUserPasswordOptions: object

Type declaration:

Name	Type
currentPassword	string
newPassword	string

Defined in: client/apis/AuthAPI.ts:104

---

ChangeUsername

Ƭ ChangeUsername: unknown

Defined in: client/apis/AuthAPI.ts:206

---

ChangeUsernameOptions

Ƭ ChangeUsernameOptions: object

Type declaration:

Name	Type
password	string
username	string

Defined in: client/apis/AuthAPI.ts:202

---

GetAuthMetaData

Ƭ GetAuthMetaData: object

Type declaration:

Name	Type
cookieLawNoticeTimeout	number

Defined in: client/apis/AuthAPI.ts:8

---

GetAuthTicket

Ƭ GetAuthTicket: object

Type declaration:

Name	Type
authTicket	string

Defined in: client/apis/AuthAPI.ts:5

---

GetCredentialsVerificationStatus

Ƭ GetCredentialsVerificationStatus: object

Type declaration:

Name	Type
canSend	boolean

Defined in: client/apis/AuthAPI.ts:35

---

GetCredentialsVerificationStatusOptions

Ƭ GetCredentialsVerificationStatusOptions: object

Type declaration:

Name	Type
credentialType	Email | Username | PhoneNumber
credentialValue	string
password	string

Defined in: client/apis/AuthAPI.ts:30

---

GetCurrentPasswordStatus

Ƭ GetCurrentPasswordStatus: object

Type declaration:

Name	Type
valid	boolean

Defined in: client/apis/AuthAPI.ts:48

---

GetExistingUsernames

Ƭ GetExistingUsernames: object

Type declaration:

Name	Type
usernames	string[]

Defined in: client/apis/AuthAPI.ts:161

---

GetExistingUsernamesOptions

Ƭ GetExistingUsernamesOptions: object

Type declaration:

Name	Type
username	string

Defined in: client/apis/AuthAPI.ts:158

---

GetMetaData

Ƭ GetMetaData: object

Type declaration:

Name	Type
ftuxAvatarAssetMap	string
isUpdateUsernameEnabled	boolean

Defined in: client/apis/AuthAPI.ts:44

---

GetPasswordResetMetaData

Ƭ GetPasswordResetMetaData: object

Type declaration:

Name	Type
users	{ displayName: string ; userId: number ; username: string }[]

Defined in: client/apis/AuthAPI.ts:56

---

GetPasswordResetMetaDataOptions

Ƭ GetPasswordResetMetaDataOptions: object

Type declaration:

Name	Type
targetType	Email | PhoneNumber
ticket	string

Defined in: client/apis/AuthAPI.ts:52

---

GetRecoveryMetaData

Ƭ GetRecoveryMetaData: object

Type declaration:

Name	Type
codeLength	number
isBedev2CaptchaEnabledForPasswordReset	boolean
isOnPhone	boolean
isPhoneFeatureEnabledForPassword	boolean
isPhoneFeatureEnabledForUsername	boolean

Defined in: client/apis/AuthAPI.ts:109

---

GetSAMLMetaData

Ƭ GetSAMLMetaData: unknown

Defined in: client/apis/AuthAPI.ts:133

---

GetTwoStepVerificationMetaData

Ƭ GetTwoStepVerificationMetaData: object

Type declaration:

Name	Type
codeLength	number
loadingImageUrl	string
supportUrl	string

Defined in: client/apis/AuthAPI.ts:135

---

Login

Ƭ Login: object

Type declaration:

Name	Type
twoStepVerificationData?	object
twoStepVerificationData.mediaType	Email | string
twoStepVerificationData.ticket	string
user	object
user.displayName	string
user.id	number
user.name	string

Defined in: client/apis/AuthAPI.ts:18

---

LoginOptions

Ƭ LoginOptions: object

Type declaration:

Name	Type
captchaProvider	PROVIDER_ARKOSELABS | string
captchaToken	string
ctype	Email | Username | string
cvalue	string
password	string

Defined in: client/apis/AuthAPI.ts:11

---

Logout

Ƭ Logout: unknown

Defined in: client/apis/AuthAPI.ts:29

---

RecoverUsernames

Ƭ RecoverUsernames: object

Type declaration:

Name	Type
transmissionType	string

Defined in: client/apis/AuthAPI.ts:177

---

RecoverUsernamesOptions

Ƭ RecoverUsernamesOptions: object

Type declaration:

Name	Type
target	string
targetType	Email | string

Defined in: client/apis/AuthAPI.ts:173

---

RequestTwoStepVerification

Ƭ RequestTwoStepVerification: object

Type declaration:

Name	Type
mediaType	Email | PhoneNumber | string
ticket	string

Defined in: client/apis/AuthAPI.ts:146

---

ResendTwoStepVerification

Ƭ ResendTwoStepVerification: RequestTwoStepVerification

Defined in: client/apis/AuthAPI.ts:145

---

ResendTwoStepVerificationOptions

Ƭ ResendTwoStepVerificationOptions: object

Type declaration:

Name	Type
actionType	string
ticket	string
username	string

Defined in: client/apis/AuthAPI.ts:140

---

ResetPassword

Ƭ ResetPassword: Login

Defined in: client/apis/AuthAPI.ts:70

---

ResetPasswordOptions

Ƭ ResetPasswordOptions: object

Type declaration:

Name	Type
password	string
passwordRepeated	string
targetType	Email | PhoneNumber
ticket	string
userId	number

Defined in: client/apis/AuthAPI.ts:63

---

RevertAccount

Ƭ RevertAccount: Login

Defined in: client/apis/AuthAPI.ts:132

---

RevertAccountInfo

Ƭ RevertAccountInfo: object

Type declaration:

Name	Type
isEmailChanged	boolean
isEmailVerified	boolean
isTwoStepVerificationEnabled	boolean
ticket	string
userId	number
username	string

Defined in: client/apis/AuthAPI.ts:119

---

RevertAccountInfoOptions

Ƭ RevertAccountInfoOptions: object

Type declaration:

Name	Type
ticket	string

Defined in: client/apis/AuthAPI.ts:116

---

RevertAccountOptions

Ƭ RevertAccountOptions: object

Type declaration:

Name	Type
newPassword	string
ticket	string
userId	number

Defined in: client/apis/AuthAPI.ts:127

---

SAMLRequest

Ƭ SAMLRequest: unknown

Defined in: client/apis/AuthAPI.ts:134

---

SendCredentialsVerificationMessage

Ƭ SendCredentialsVerificationMessage: unknown

Defined in: client/apis/AuthAPI.ts:43

---

SendCredentialsVerificationMessageOptions

Ƭ SendCredentialsVerificationMessageOptions: object

Type declaration:

Name	Type
credentialType	Email | Username | PhoneNumber
credentialValue	string
password	string

Defined in: client/apis/AuthAPI.ts:38

---

SendPasswordReset

Ƭ SendPasswordReset: object

Type declaration:

Name	Type
nonce	string
transmissionType	string

Defined in: client/apis/AuthAPI.ts:85

---

SendPasswordResetOptions

Ƭ SendPasswordResetOptions: object

Type declaration:

Name	Type
captchaProvider	PROVIDER_ARKOSELABS | string
captchaToken	string
target	string
targetType	ResetPasswordOptions[targetType]

Defined in: client/apis/AuthAPI.ts:79

---

SignUp

Ƭ SignUp: object

Type declaration:

Name	Type
starterPlaceId	number
userId	number

Defined in: client/apis/AuthAPI.ts:198

---

SignUpOptions

Ƭ SignUpOptions: object

Type declaration:

Name	Type
assetIds	number[]
birthday	string
bodyColorId	number
bodyTypeScale	number
captchaProvider	string
captchaToken	string
email	string
gender	Unknown | string
headScale	number
heightScale	number
isTosAgreementBoxChecked	boolean
locale	string
password	string
proportionScale	number
username	string
widthScale	number

Defined in: client/apis/AuthAPI.ts:180

---

ValidatePassword

Ƭ ValidatePassword: object

Type declaration:

Name	Type
code	string
message	string

Defined in: client/apis/AuthAPI.ts:75

---

ValidatePasswordOptions

Ƭ ValidatePasswordOptions: object

Type declaration:

Name	Type
password	string
username	string

Defined in: client/apis/AuthAPI.ts:71

---

ValidateUsername

Ƭ ValidateUsername: object

Type declaration:

Name	Type
code	string
message	string

Defined in: client/apis/AuthAPI.ts:169

---

ValidateUsernameOptions

Ƭ ValidateUsernameOptions: object

Type declaration:

Name	Type
birthday	string
context	Unknown | Signup | UsernameChange | string
username	string

Defined in: client/apis/AuthAPI.ts:164

---

VerifyPasswordReset

Ƭ VerifyPasswordReset: object

Type declaration:

Name	Type
userTickets	{ ticket: string ; user: { displayName: string ; userId: number ; username: string } }[]

Defined in: client/apis/AuthAPI.ts:94

---

VerifyPasswordResetOptions

Ƭ VerifyPasswordResetOptions: object

Type declaration:

Name	Type
code	string
nonce	string
targetType	ResetPasswordOptions[targetType]

Defined in: client/apis/AuthAPI.ts:89

---

VerifyTwoStepVerification

Ƭ VerifyTwoStepVerification: unknown

Defined in: client/apis/AuthAPI.ts:157

---

VerifyTwoStepVerificationOptions

Ƭ VerifyTwoStepVerificationOptions: object

Type declaration:

Name	Type
actionType	string
code	string
rememberDevice	boolean
ticket	string
username	string

Defined in: client/apis/AuthAPI.ts:150