Structs§
- ApiKey
- Credentials
- Partial
ApiKey Partial<ApiKey>in the TypeScript SDK.- Partial
Credentials Partial<Pick<Credentials, 'displayName' | 'icon' | 'email' | 'phone'>>in the TypeScript SDK. Email and phone are only accepted while that one isn’t verified yet; a change sends a new link and code.- Partial
Profile Partial<Profile>in the TypeScript SDK.- Profile
- Session
- One place you’re signed in.
idnames the session; it is not its token.
Enums§
- ApiKey
OrGroup ApiKey | Groupin the TypeScript SDK.- Credentials
OrApi Key Credentials | ApiKeyin the TypeScript SDK.- Verification
Channel 'EMAIL' | 'PHONE'in the TypeScript SDK.
Functions§
- allocate_
balance - authorize
- authorize_
api_ key - authorize_
token - change_
password - A new password, given the current one. Every other session ends; this one stays.
- create
- edit
- edit_
api_ key - forgot_
password - Emails a link and code for choosing a new password, when an account has that email. Answers the same either way.
- generate_
api_ key - handoff
- A single use code that passes this session to another page or app for a minute, so the token never rides in a URL.
- profile
- query
- redeem_
handoff - Uses up a handoff code for the session token it passes.
- remove_
api_ key - reset_
password - A new password, with the code from a reset email. The email counts as verified, and every session ends.
- revoke_
session - Ends one of your sessions.
- send_
verification - sessions
- Your live sessions, newest first.
- sign_
out - Ends the session
credentialssigned in with. - sign_
out_ everywhere - Ends every one of your sessions, this one too.
- verify