Class: AuthEndpoint

Defined in: endpoints/auth.ts:21

Constructors

Constructor

new AuthEndpoint(client): AuthEndpoint;

Defined in: endpoints/auth.ts:22

Parameters

Parameter	Type
client	RESTClient

Returns

AuthEndpoint

Methods

blockPasswordResets()

blockPasswordResets(days): Promise<IBlockResetResponse>;

Defined in: endpoints/auth.ts:82

Parameters

Parameter	Type
days	number

Returns

Promise<IBlockResetResponse>

---

changePassword()

changePassword(currentPassword, newPassword): Promise<IUpdatePasswordResponse>;

Defined in: endpoints/auth.ts:62

Parameters

Parameter	Type
currentPassword	string
newPassword	string

Returns

Promise<IUpdatePasswordResponse>

---

checkLoginStatus()

checkLoginStatus(loginToken): Promise<IAuthResponse>;

Defined in: endpoints/auth.ts:125

Parameters

Parameter	Type
loginToken	string

Returns

Promise<IAuthResponse>

---

completeAddEmail()

completeAddEmail(validationToken): Promise<IApiResponse>;

Defined in: endpoints/auth.ts:150

Completes from the emailed link. Nothing about the account is returned; refresh the user to see the method.

Parameters

Parameter	Type
validationToken	string

Returns

Promise<IApiResponse>

---

completeEmailChange()

completeEmailChange(validationToken): Promise<IUpdateEmailResponse>;

Defined in: endpoints/auth.ts:140

Changes the email to the address the link was sent to. Ends every sign-in on the account.

Parameters

Parameter	Type
validationToken	string

Returns

Promise<IUpdateEmailResponse>

---

completeOAuthHandoff()

completeOAuthHandoff(
   provider, 
   state, 
   result
): Promise<IApiResponse>;

Defined in: endpoints/auth.ts:107

run by the browser after the provider redirects back; leaves the outcome for the waiting client

Parameters

Parameter	Type
provider	string
state	string
result	| { code: string; } | { error: string; }

Returns

Promise<IApiResponse>

---

completeOAuthLink()

completeOAuthLink(
   provider, 
   state, 
   code
): Promise<IAuthMethodsResponse>;

Defined in: endpoints/auth.ts:169

Completes a link started in this app, from the code the provider's callback page relayed.

Parameters

Parameter	Type
provider	string
state	string
code	string

Returns

Promise<IAuthMethodsResponse>

---

getCurrentUser()

getCurrentUser(): Promise<IGetCurrentUserResponse>;

Defined in: endpoints/auth.ts:58

Returns

Promise<IGetCurrentUserResponse>

---

getOAuthLoginUrl()

getOAuthLoginUrl(provider, handoffChallenge?): Promise<IOAuthAuthorizeUrlResponse>;

Defined in: endpoints/auth.ts:101

Parameters

Parameter	Type
provider	string
handoffChallenge?	string

Returns

Promise<IOAuthAuthorizeUrlResponse>

---

listSignIns()

listSignIns(): Promise<IListSignInsResponse>;

Defined in: endpoints/auth.ts:188

Returns

Promise<IListSignInsResponse>

---

login()

login(
   email, 
   password, 
   options?
): Promise<IAuthResponse>;

Defined in: endpoints/auth.ts:29

persistent asks for a sign-in that lasts until it is signed out or revoked, as the mobile app's does, rather than one that lapses after a month without use.

Parameters

Parameter	Type
email	string
password	string
options?	{ persistent?: boolean; }
options.persistent?	boolean

Returns

Promise<IAuthResponse>

---

logout()

logout(refreshToken): Promise<IApiResponse>;

Defined in: endpoints/auth.ts:54

End this sign-in on the server: its refresh token, every session made from it, and the push registration of the device it was on. Needs only the refresh token, so it works after the session has run out. Idempotent.

Parameters

Parameter	Type
refreshToken	string

Returns

Promise<IApiResponse>

---

oauthCallback()

oauthCallback(
   provider, 
   code, 
   state
): Promise<IAuthResponse>;

Defined in: endpoints/auth.ts:120

Parameters

Parameter	Type
provider	string
code	string
state	string

Returns

Promise<IAuthResponse>

---

pollLoginHandoff()

pollLoginHandoff(verifier): Promise<
  | IAuthResponse
| IHandoffPendingResponse>;

Defined in: endpoints/auth.ts:116

the waiting client's check; the verifier goes in the body so it stays out of URLs and logs

Parameters

Parameter	Type
verifier	string

Returns

Promise< | IAuthResponse | IHandoffPendingResponse>

---

pollOAuthLink()

pollOAuthLink(provider, verifier): Promise<
  | IAuthMethodsResponse
| IHandoffPendingResponse>;

Defined in: endpoints/auth.ts:174

The desktop app's check for a link finished in the system browser. The verifier goes in the body.

Parameters

Parameter	Type
provider	string
verifier	string

Returns

Promise< | IAuthMethodsResponse | IHandoffPendingResponse>

---

refreshSession()

refreshSession(refreshToken): Promise<IRefreshTokenResponse>;

Defined in: endpoints/auth.ts:45

Parameters

Parameter	Type
refreshToken	string

Returns

Promise<IRefreshTokenResponse>

---

register()

register(email, password): Promise<IAuthResponse>;

Defined in: endpoints/auth.ts:37

Parameters

Parameter	Type
email	string
password	string

Returns

Promise<IAuthResponse>

---

removeAuthMethod()

removeAuthMethod(id, currentPassword?): Promise<IAuthMethodsResponse>;

Defined in: endpoints/auth.ts:184

Removes a sign-in method. The account must keep at least one usable method. Sign-ins stay active; the user can end them separately from Sessions.

Parameters

Parameter	Type
id	number
currentPassword?	string

Returns

Promise<IAuthMethodsResponse>

---

requestAddEmail()

requestAddEmail(email, password): Promise<IApiResponse>;

Defined in: endpoints/auth.ts:145

Adds an email and password to an account that signs in only with OAuth providers.

Parameters

Parameter	Type
email	string
password	string

Returns

Promise<IApiResponse>

---

requestEmailChange()

requestEmailChange(email, password): Promise<IApiResponse>;

Defined in: endpoints/auth.ts:135

Sends a link to the new address. The account keeps its current email until that link is used, so a mistyped or unwanted address changes nothing.

Parameters

Parameter	Type
email	string
password	string

Returns

Promise<IApiResponse>

---

requestEmailVerification()

requestEmailVerification(email, loginToken?): Promise<IEmailVerifyResponse>;

Defined in: endpoints/auth.ts:90

Parameters

Parameter	Type
email	string
loginToken?	string

Returns

Promise<IEmailVerifyResponse>

---

requestPasswordReset()

requestPasswordReset(email): Promise<IRequestPasswordResetResponse>;

Defined in: endpoints/auth.ts:69

Parameters

Parameter	Type
email	string

Returns

Promise<IRequestPasswordResetResponse>

---

resetPassword()

resetPassword(resetToken, newPassword): Promise<IResetPasswordResponse>;

Defined in: endpoints/auth.ts:75

Parameters

Parameter	Type
resetToken	string
newPassword	string

Returns

Promise<IResetPasswordResponse>

---

revokeOtherSignIns()

revokeOtherSignIns(): Promise<IRevokeSignInsResponse>;

Defined in: endpoints/auth.ts:198

Ends every sign-in except the current one.

Returns

Promise<IRevokeSignInsResponse>

---

revokeSignIn()

revokeSignIn(id): Promise<IApiResponse>;

Defined in: endpoints/auth.ts:193

Ends one sign-in other than the current one. Use logout for the current one.

Parameters

Parameter	Type
id	string

Returns

Promise<IApiResponse>

---

startOAuthLink()

startOAuthLink(provider, options?): Promise<IOAuthAuthorizeUrlResponse>;

Defined in: endpoints/auth.ts:158

Starts linking a provider to the signed-in account. Needs the current password when the account has one. The returned URL is opened in the browser.

Parameters

Parameter	Type
provider	string
options?	{ currentPassword?: string; handoffChallenge?: string; }
options.currentPassword?	string
options.handoffChallenge?	string

Returns

Promise<IOAuthAuthorizeUrlResponse>

---

verifyEmail()

verifyEmail(validationToken): Promise<IEmailVerifyResponse>;

Defined in: endpoints/auth.ts:95

Parameters

Parameter	Type
validationToken	string

Returns

Promise<IEmailVerifyResponse>