@authefy/node-client
v0.1.3
Published
Authefy NodeJS SDK
Downloads
9
Readme
Authefy SDK
An Authefy Web Client runs only in Node.js server. It simplifies the use of Authefy endpoints by providing set of libraries that are familiar for javascript developers.
import Client from '@authefy/node-client';
const authefyNodeClient = new Client({
appAccessKey: process.env.AUTHEFY_APP_ACCESS_KEY
});
Installation
To use with node:
$ npm install @authefy/node-client
Features
- Register user to Authefy
- Update user with user id
- Delete user with user id
- Get user information with user id
- Get all application's user information
- Get all user events
- Listen to user events
- Login using
bitclout
,password
&refreshToken
- Authorize Bearer token
- Revoke refresh token
Docs & Community
- Documentation - WIP
Entities
Object: User
{
id: string;
externalId?: string;
username: string;
groups: string[];
isEmailVerified: boolean;
isVerified: boolean;
details: Record<string, any>;
}
Object: UserEvent
{
id: string
user: string;
externalId?: string;
application: string;
type: UserCreated | UserUpdated | UserDeleted;
body?: Record<string, any>;
dateTimeCreated: string;
cursor: string;
}