- Preparing search index...
- The search index is not available
Vulpo Auth
Methods
activate
- activate(userId: string): void
-
Returns void
confirmPasswordless
- confirmPasswordless(id: string, token: string, config?: Partial<Request>): Promise<void>
-
Parameters
-
id: string
-
token: string
-
Optional
config: Partial<Request>
Returns Promise<void>
confirmUpdateEmail
- confirmUpdateEmail(id: string, token: string, config?: Partial<Request>): Promise<void>
-
Parameters
-
id: string
-
token: string
-
Optional
config: Partial<Request>
Returns Promise<void>
deleteApiKey
- deleteApiKey(id: string, config?: Partial<Request>): Promise<void>
-
Parameters
-
id: string
-
Optional
config: Partial<Request>
Returns Promise<void>
flags
- flags(config?: Partial<Request>): Promise<Flag[]>
-
Parameters
-
Optional
config: Partial<Request>
Returns Promise<Flag[]>
forceToken
- forceToken(sessionId?: string): Promise<string>
-
Parameters
-
Optional
sessionId: string
Returns Promise<string>
generateApiKey
- generateApiKey(payload: GenerateApiKey, config?: Partial<Request>): Promise<GenerateApiKeyResponse>
-
Parameters
-
payload: GenerateApiKey
-
Optional
config: Partial<Request>
getToken
- getToken(sessionId?: string): Promise<string>
-
Parameters
-
Optional
sessionId: string
Returns Promise<string>
getUser
- getUser(): null | User
-
Returns null | User
listApiKeys
- listApiKeys(config?: Partial<Request>): Promise<ApiKeys>
-
Parameters
-
Optional
config: Partial<Request>
Returns Promise<ApiKeys>
oAuthConfirm
- oAuthConfirm(csrf_token: string, code: string, config?: Partial<Request>): Promise<[null | User, string]>
-
Parameters
-
csrf_token: string
-
code: string
-
Optional
config: Partial<Request>
Returns Promise<[null | User, string]>
oAuthGetAuthorizeUrl
- oAuthGetAuthorizeUrl(provider: "google", config?: Partial<Request>): Promise<string>
-
Parameters
-
provider: "google"
-
Optional
config: Partial<Request>
Returns Promise<string>
passwordless
- passwordless(email: string, config?: Partial<Request>): Promise<{
id: string;
session: string;
}>
-
Parameters
-
email: string
-
Optional
config: Partial<Request>
Returns Promise<{
id: string;
session: string;
}>
rejectUpdateEmail
- rejectUpdateEmail(id: string, token: string, config?: Partial<Request>): Promise<void>
-
Parameters
-
id: string
-
token: string
-
Optional
config: Partial<Request>
Returns Promise<void>
resetPassword
- resetPassword(email: string, config?: Partial<Request>): Promise<void>
-
Parameters
-
email: string
-
Optional
config: Partial<Request>
Returns Promise<void>
setPassword
- setPassword(password: string, config?: Partial<Request>): Promise<void>
-
Parameters
-
password: string
-
Optional
config: Partial<Request>
Returns Promise<void>
setProject
- setProject(id: string): void
-
Returns void
setResetPassword
- setResetPassword(body: SetPasswordPayload, config?: Partial<Request>): Promise<void>
-
Parameters
-
-
Optional
config: Partial<Request>
Returns Promise<void>
signIn
- signIn(email: string, password: string, config?: Partial<Request>): Promise<User>
-
Parameters
-
email: string
-
password: string
-
Optional
config: Partial<Request>
Returns Promise<User>
signOut
- signOut(sessionId?: string, config?: Partial<Request>): Promise<unknown>
-
Parameters
-
Optional
sessionId: string
-
Optional
config: Partial<Request>
Returns Promise<unknown>
signOutAll
- signOutAll(sessionId?: string, config?: Partial<Request>): Promise<unknown>
-
Parameters
-
Optional
sessionId: string
-
Optional
config: Partial<Request>
Returns Promise<unknown>
signUp
- signUp(email: string, password: string, config?: Partial<Request>): Promise<User>
-
Parameters
-
email: string
-
password: string
-
Optional
config: Partial<Request>
Returns Promise<User>
updateEmail
- updateEmail(email: string, config?: Partial<Request>): Promise<void>
-
Parameters
-
email: string
-
Optional
config: Partial<Request>
Returns Promise<void>
verifyEmail
- verifyEmail(id: string, token: string, config?: Partial<Request>): Promise<void>
-
Parameters
-
id: string
-
token: string
-
Optional
config: Partial<Request>
Returns Promise<void>
verifyPasswordless
- verifyPasswordless(id: string, session: string, config?: Partial<Request>): Promise<null | User>
-
Parameters
-
id: string
-
session: string
-
Optional
config: Partial<Request>
Returns Promise<null | User>
verifyToken
- verifyToken(id: string, token: string, config?: Partial<Request>): Promise<void>
-
Parameters
-
id: string
-
token: string
-
Optional
config: Partial<Request>
Returns Promise<void>
withToken
- withToken(fn: ((token: string) => Promise<Response>), session?: string): Promise<Response>
-
Parameters
-
fn: ((token: string) => Promise<Response>)
-
- (token: string): Promise<Response>
-
Returns Promise<Response>
-
Optional
session: string
Returns Promise<Response>