Sign In/Out
These are the functions you would use in your dApp to interact with Ramper. Import each from @ramper/ethereum
Sign in
The sign in options such as which SSO providers to allow and which Web3 wallets to allow can be customized through the init
function. It is recommend to call this function when the user clicks the Sign In Button on your web app.
The clientAPIKey is optional. You can obtain it from Ramper Developer Console (coming soon)
Sign out
Response Types
The method
value is 'ramper'
if the user logged in using SSO or email and a Ramper managed wallet is created for them. The method
value is 'wallet'
if the user used a Web3 wallet such as Metamask to log in. Lastly, the method returns 'none'
if the user cancels the log in process.
The user
value contains information regarding the user that logged in. The apiGatingToken
is generated based on the clientAPIKey
if that value was provided on signIn
. The apiGatingToken
is an JWT idToken that can be decoded with the clientAPIKey
. This key can be used to verify that the user has logged in properly.
Example Response:
Related Data Types:
Last updated