Class AuthApi

Hierarchy

AuthApi

Constructors

constructor

new AuthApi(storage, authManager, validateAndRefreshToken, ensureInitialized): AuthApi
Parameters
- storage: Storage
- authManager: AuthManager
- validateAndRefreshToken: (() => Promise<void>)
  - - (): Promise<void>
    - Returns Promise<void>
- ensureInitialized: (() => Promise<void>)
  - - (): Promise<void>
    - Returns Promise<void>
Returns AuthApi
- Defined in sdk/src/api/auth.ts:20

Properties

`Private` storage

storage: Storage

`Private` authManager

authManager: AuthManager

`Private` validateAndRefreshToken

validateAndRefreshToken: (() => Promise<void>)

Type declaration

- (): Promise<void>
- Returns Promise<void>

`Private` ensureInitialized

ensureInitialized: (() => Promise<void>)

Type declaration

- (): Promise<void>
- Returns Promise<void>

Methods

logInWithEmailPassword

logInWithEmailPassword(__namedParameters): Promise<AuthResponse | AuthActionRequiredResponse>
Parameters
- __namedParameters: {
      email: string;
      password: string;
      ecosystemGame?: string;
  }
  - email: string
  - password: string
  - Optional ecosystemGame?: string
Returns Promise<AuthResponse | AuthActionRequiredResponse>
- Defined in sdk/src/api/auth.ts:27

signUpGuest

signUpGuest(): Promise<AuthResponse>
Returns Promise<AuthResponse>
- Defined in sdk/src/api/auth.ts:43

signUpWithEmailPassword

signUpWithEmailPassword(__namedParameters): Promise<AuthResponse | AuthActionRequiredResponse>
Parameters
- __namedParameters: {
      email: string;
      password: string;
      options?: {
          data: {
              name: string;
          };
      };
      ecosystemGame?: string;
  }
  - email: string
  - password: string
  - Optional options?: {
        data: {
            name: string;
        };
    }
    - data: {
      name: string;
      }
      
      name: string
  - Optional ecosystemGame?: string
Returns Promise<AuthResponse | AuthActionRequiredResponse>
- Defined in sdk/src/api/auth.ts:54

linkEmailPassword

linkEmailPassword(__namedParameters): Promise<AuthPlayerResponse | AuthActionRequiredResponse>
Parameters
- __namedParameters: {
      email: string;
      password: string;
      authToken: string;
      ecosystemGame?: string;
  }
  - email: string
  - password: string
  - authToken: string
  - Optional ecosystemGame?: string
Returns Promise<AuthPlayerResponse | AuthActionRequiredResponse>
- Defined in sdk/src/api/auth.ts:72

unlinkEmailPassword

unlinkEmailPassword(__namedParameters): Promise<AuthPlayerResponse>
Parameters
- __namedParameters: {
  email: string;
  authToken: string;
  }
  - email: string
  - authToken: string
Returns Promise<AuthPlayerResponse>
- Defined in sdk/src/api/auth.ts:80

requestEmailVerification

requestEmailVerification(__namedParameters): Promise<void>
Parameters
- __namedParameters: {
  email: string;
  redirectUrl: string;
  }
  - email: string
  - redirectUrl: string
Returns Promise<void>
- Defined in sdk/src/api/auth.ts:86

resetPassword

resetPassword(__namedParameters): Promise<void>
Parameters
- __namedParameters: {
      email: string;
      password: string;
      state: string;
  }
  - email: string
  - password: string
  - state: string
Returns Promise<void>
- Defined in sdk/src/api/auth.ts:92

requestResetPassword

requestResetPassword(__namedParameters): Promise<void>
Parameters
- __namedParameters: {
  email: string;
  redirectUrl: string;
  }
  - email: string
  - redirectUrl: string
Returns Promise<void>
- Defined in sdk/src/api/auth.ts:98

verifyEmail

verifyEmail(__namedParameters): Promise<void>
Parameters
- __namedParameters: {
  email: string;
  state: string;
  }
  - email: string
  - state: string
Returns Promise<void>
- Defined in sdk/src/api/auth.ts:105

initOAuth

initOAuth(__namedParameters): Promise<InitAuthResponse>
Parameters
- __namedParameters: {
      provider: OAuthProvider;
      options?: InitializeOAuthOptions;
      ecosystemGame?: string;
  }
  - provider: OAuthProvider
  - Optional options?: InitializeOAuthOptions
  - Optional ecosystemGame?: string
Returns Promise<InitAuthResponse>
- Defined in sdk/src/api/auth.ts:109

initLinkOAuth

initLinkOAuth(__namedParameters): Promise<InitAuthResponse>
Parameters
- __namedParameters: {
      provider: OAuthProvider;
      authToken: string;
      options?: InitializeOAuthOptions;
      ecosystemGame?: string;
  }
  - provider: OAuthProvider
  - authToken: string
  - Optional options?: InitializeOAuthOptions
  - Optional ecosystemGame?: string
Returns Promise<InitAuthResponse>
- Defined in sdk/src/api/auth.ts:118

linkThirdPartyProvider

linkThirdPartyProvider(__namedParameters): Promise<AuthPlayerResponse>
Parameters
- __namedParameters: {
      provider: ThirdPartyOAuthProvider;
      token: string;
      tokenType: TokenType;
  }
  - provider: ThirdPartyOAuthProvider
  - token: string
  - tokenType: TokenType
Returns Promise<AuthPlayerResponse>
- Defined in sdk/src/api/auth.ts:132

unlinkOAuth

unlinkOAuth(__namedParameters): Promise<AuthPlayerResponse>
Parameters
- __namedParameters: {
  provider: OAuthProvider;
  authToken: string;
  }
  - provider: OAuthProvider
  - authToken: string
Returns Promise<AuthPlayerResponse>
- Defined in sdk/src/api/auth.ts:144

poolOAuth

poolOAuth(key): Promise<AuthResponse>
Parameters
- key: string
Returns Promise<AuthResponse>
- Defined in sdk/src/api/auth.ts:150

authenticateWithThirdPartyProvider

authenticateWithThirdPartyProvider(__namedParameters): Promise<AuthPlayerResponse>
Parameters
- __namedParameters: {
      provider: ThirdPartyOAuthProvider;
      token: string;
      tokenType: TokenType;
      ecosystemGame?: string;
  }
  - provider: ThirdPartyOAuthProvider
  - token: string
  - tokenType: TokenType
  - Optional ecosystemGame?: string
Returns Promise<AuthPlayerResponse>
- Defined in sdk/src/api/auth.ts:161

loginWithIdToken

loginWithIdToken(__namedParameters): Promise<AuthResponse>
Parameters
- __namedParameters: {
      provider: OAuthProvider;
      token: string;
      ecosystemGame?: string;
  }
  - provider: OAuthProvider
  - token: string
  - Optional ecosystemGame?: string
Returns Promise<AuthResponse>
- Defined in sdk/src/api/auth.ts:176

initSIWE

initSIWE(__namedParameters): Promise<SIWEInitResponse>
Parameters
- __namedParameters: {
  address: string;
  ecosystemGame?: string;
  }
  - address: string
  - Optional ecosystemGame?: string
Returns Promise<SIWEInitResponse>
- Defined in sdk/src/api/auth.ts:191

authenticateWithSIWE

authenticateWithSIWE(__namedParameters): Promise<AuthResponse>
Parameters
- __namedParameters: {
      signature: string;
      message: string;
      walletClientType: string;
      connectorType: string;
  }
  - signature: string
  - message: string
  - walletClientType: string
  - connectorType: string
Returns Promise<AuthResponse>
- Defined in sdk/src/api/auth.ts:198

linkWallet

linkWallet(__namedParameters): Promise<AuthPlayerResponse>
Parameters
- __namedParameters: {
      signature: string;
      message: string;
      walletClientType: string;
      connectorType: string;
      authToken: string;
  }
  - signature: string
  - message: string
  - walletClientType: string
  - connectorType: string
  - authToken: string
Returns Promise<AuthPlayerResponse>
- Defined in sdk/src/api/auth.ts:211

unlinkWallet

unlinkWallet(__namedParameters): Promise<AuthPlayerResponse>
Parameters
- __namedParameters: {
  address: string;
  authToken: string;
  }
  - address: string
  - authToken: string
Returns Promise<AuthPlayerResponse>
- Defined in sdk/src/api/auth.ts:219

storeCredentials

storeCredentials(auth): Promise<void>
Parameters
- auth: Auth
Returns Promise<void>
- Defined in sdk/src/api/auth.ts:225

logout

logout(): Promise<void>
Logs the user out by flushing the signer and removing credentials.

Returns Promise<void>
- Defined in sdk/src/api/auth.ts:236

Class AuthApi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

storage: Storage

authManager: AuthManager

validateAndRefreshToken: (() => Promise<void>)

Returns Promise<void>

ensureInitialized: (() => Promise<void>)

Returns Promise<void>

Returns AuthApi

Properties

Private storage

Private authManager

Private validateAndRefreshToken

Type declaration

Returns Promise<void>

Private ensureInitialized

Type declaration

Returns Promise<void>

Methods

logInWithEmailPassword

Parameters

__namedParameters: { email: string; password: string; ecosystemGame?: string; }

email: string

password: string

Optional ecosystemGame?: string

Returns Promise<AuthResponse | AuthActionRequiredResponse>

signUpGuest

Returns Promise<AuthResponse>

signUpWithEmailPassword

Parameters

__namedParameters: { email: string; password: string; options?: { data: { name: string; }; }; ecosystemGame?: string; }

email: string

password: string

Optional options?: { data: { name: string; }; }

data: { name: string; }

name: string

Optional ecosystemGame?: string

Returns Promise<AuthResponse | AuthActionRequiredResponse>

linkEmailPassword

Parameters

__namedParameters: { email: string; password: string; authToken: string; ecosystemGame?: string; }

email: string

password: string

authToken: string

Optional ecosystemGame?: string

Returns Promise<AuthPlayerResponse | AuthActionRequiredResponse>

unlinkEmailPassword

Parameters

__namedParameters: { email: string; authToken: string; }

email: string

authToken: string

Returns Promise<AuthPlayerResponse>

requestEmailVerification

Parameters

__namedParameters: { email: string; redirectUrl: string; }

email: string

redirectUrl: string

Returns Promise<void>

resetPassword

Parameters

__namedParameters: { email: string; password: string; state: string; }

email: string

password: string

state: string

Returns Promise<void>

requestResetPassword

Parameters

__namedParameters: { email: string; redirectUrl: string; }

email: string

redirectUrl: string

Returns Promise<void>

verifyEmail

Parameters

`Private` storage

`Private` authManager

`Private` validateAndRefreshToken

`Private` ensureInitialized

__namedParameters: {
email: string;
password: string;
ecosystemGame?: string;
}

`Optional` ecosystemGame?: string

__namedParameters: {
email: string;
password: string;
options?: {
data: {
name: string;
};
};
ecosystemGame?: string;
}

`Optional` options?: {
data: {
name: string;
};
}

data: {
name: string;
}

`Optional` ecosystemGame?: string

__namedParameters: {
email: string;
password: string;
authToken: string;
ecosystemGame?: string;
}

`Optional` ecosystemGame?: string

__namedParameters: {
email: string;
authToken: string;
}

__namedParameters: {
email: string;
redirectUrl: string;
}

__namedParameters: {
email: string;
password: string;
state: string;
}

__namedParameters: {
email: string;
redirectUrl: string;
}

__namedParameters: {
email: string;
state: string;
}

__namedParameters: {
provider: OAuthProvider;
options?: InitializeOAuthOptions;
ecosystemGame?: string;
}

`Optional` options?: InitializeOAuthOptions

`Optional` ecosystemGame?: string

__namedParameters: {
provider: OAuthProvider;
authToken: string;
options?: InitializeOAuthOptions;
ecosystemGame?: string;
}

`Optional` options?: InitializeOAuthOptions

`Optional` ecosystemGame?: string

__namedParameters: {
provider: ThirdPartyOAuthProvider;
token: string;
tokenType: TokenType;
}

__namedParameters: {
provider: OAuthProvider;
authToken: string;
}

__namedParameters: {
provider: ThirdPartyOAuthProvider;
token: string;
tokenType: TokenType;
ecosystemGame?: string;
}

`Optional` ecosystemGame?: string

__namedParameters: {
provider: OAuthProvider;
token: string;
ecosystemGame?: string;
}

`Optional` ecosystemGame?: string

__namedParameters: {
address: string;
ecosystemGame?: string;
}

`Optional` ecosystemGame?: string

__namedParameters: {
signature: string;
message: string;
walletClientType: string;
connectorType: string;
}

__namedParameters: {
signature: string;
message: string;
walletClientType: string;
connectorType: string;
authToken: string;
}