Auth | @cxcloud/core

Index

Functions

Functions

login

login(username: string, password: string): Promise<LoginSuccessResult | LoginNextStepResult>

- Defined in auth/index.ts:46
Parameters
- username: string
- password: string
Returns Promise<LoginSuccessResult | LoginNextStepResult>

loginMfa

loginMfa(username: string, mfaCode: string, loginSession: string): Promise<LoginSuccessResult>

- Defined in auth/index.ts:56
Parameters
- username: string
- mfaCode: string
- loginSession: string
Returns Promise<LoginSuccessResult>

loginNewPasswordRequired

loginNewPasswordRequired(username: string, newPassword: string, loginSession: string): Promise<LoginSuccessResult>

- Defined in auth/index.ts:68
Parameters
- username: string
- newPassword: string
- loginSession: string
Returns Promise<LoginSuccessResult>

logout

logout(username: string, refreshToken: string): Promise<Status>

- Defined in auth/index.ts:80
Parameters
- username: string
- refreshToken: string
Returns Promise<Status>

passwordChange

passwordChange(username: string, refreshToken: string, oldPassword: string, newPassword: string): Promise<Status>

- Defined in auth/index.ts:118
Parameters
- username: string
- refreshToken: string
- oldPassword: string
- newPassword: string
Returns Promise<Status>

passwordForgot

passwordForgot(username: string): Promise<CodeDeliveryResult>

- Defined in auth/index.ts:100
Parameters
- username: string
Returns Promise<CodeDeliveryResult>

passwordReset

passwordReset(username: string, passwordResetCode: string, newPassword: string): Promise<Status>

- Defined in auth/index.ts:106
Parameters
- username: string
- passwordResetCode: string
- newPassword: string
Returns Promise<Status>

profile

profile(username: string, refreshToken: string): Promise<AttributesHash>

- Defined in auth/index.ts:132
Parameters
- username: string
- refreshToken: string
Returns Promise<AttributesHash>

profileEdit

profileEdit(username: string, refreshToken: string, attributes: AttributesHash): Promise<Status>

- Defined in auth/index.ts:144
Parameters
- username: string
- refreshToken: string
- attributes: AttributesHash
Returns Promise<Status>

profileEditPhoneNumber

profileEditPhoneNumber(username: string, refreshToken: string, phoneNumber: string): Promise<Status>

- Defined in auth/index.ts:156
Parameters
- username: string
- refreshToken: string
- phoneNumber: string
Returns Promise<Status>

refreshSession

refreshSession(username: string, refreshToken: string): Promise<LoginSuccessResult>

- Defined in auth/index.ts:90
Parameters
- username: string
- refreshToken: string
Returns Promise<LoginSuccessResult>

register

register(username: string, password: string, attributes?: AttributesHash): Promise<RegisterResult>

- Defined in auth/index.ts:17
Parameters
- username: string
- password: string
- Default value attributes: AttributesHash = {}
Returns Promise<RegisterResult>

registerConfirmation

registerConfirmation(username: string, confirmationCode: string): Promise<Status>

- Defined in auth/index.ts:29
Parameters
- username: string
- confirmationCode: string
Returns Promise<Status>

registerResendCode

registerResendCode(username: string): Promise<CodeDeliveryResult>

- Defined in auth/index.ts:38
Parameters
- username: string
Returns Promise<CodeDeliveryResult>

Generated using TypeDoc