Skip to main content

Module authentification

Module authentification 

Source

Structs§

ApiKey
Credentials
PartialApiKey
Partial<ApiKey> in the TypeScript SDK.
PartialCredentials
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.
PartialProfile
Partial<Profile> in the TypeScript SDK.
Profile
Session
One place you’re signed in. id names the session; it is not its token.

Enums§

ApiKeyOrGroup
ApiKey | Group in the TypeScript SDK.
CredentialsOrApiKey
Credentials | ApiKey in the TypeScript SDK.
VerificationChannel
'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, good for a minute, that gives another page or app a new session of the same person, so no token rides in a URL.
profile
query
Profiles matching a partial email or name, best first, at most 20. An admin’s answer carries more; this keeps the profiles.
redeem_handoff
Uses up a handoff code for the new session token it carries.
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 credentials signed in with.
sign_out_everywhere
Ends every one of your sessions, this one too.
verify

Type Aliases§

Token