Auth
The Authentication API enables users to authenticate with your application using their Puter account.
This is essential for users to access the various Puter.js APIs integrated into your application. The auth API supports several features, including sign-in, sign-out, checking authentication status, and retrieving user information.
Features
Initiates the sign in process for the user
<html>
<body>
<script src="https://js.puter.com/v2/"></script>
<button id="sign-in">Sign in</button>
<script>
// Because signIn() opens a popup window, it must be called from a user action.
document.getElementById('sign-in').addEventListener('click', async () => {
// signIn() will resolve when the user has signed in.
await puter.auth.signIn().then((res) => {
puter.print('Signed in<br>' + JSON.stringify(res));
});
});
</script>
</body>
</html>
Checks whether the user is signed into the application
<html>
<body>
<script src="https://js.puter.com/v2/"></script>
<script>
puter.print(`Sign in status: ${puter.auth.isSignedIn()}`);
</script>
</body>
</html>
Returns the user's basic information
<html>
<body>
<script src="https://js.puter.com/v2/"></script>
<script>
puter.auth.getUser().then(function(user) {
puter.print(JSON.stringify(user));
});
</script>
</body>
</html>
Signs the user out of the application
<html>
<body>
<script src="https://js.puter.com/v2/"></script>
<script>
puter.auth.signOut();
</script>
</body>
</html>
Functions
These authentication features are supported out of the box when using Puter.js:
puter.auth.signIn()- Sign in a userputer.auth.signOut()- Sign out the current userputer.auth.isSignedIn()- Check if a user is signed inputer.auth.getUser()- Get information about the current user
Examples
You can see various Puter.js authentication features in action from the following examples: