OpenPRA Documentation

backends-web-backend

Class: UsersController ​

Defined in: backends/web-backend/src/users/users.controller.ts:68

Constructors ​

Constructor ​

new UsersController(usersService, sessionsService): UsersController

Defined in: backends/web-backend/src/users/users.controller.ts:69

Parameters ​

usersService ​

UsersService

sessionsService ​

SessionsService

Returns ​

UsersController

Methods ​

changeEmail() ​

changeEmail(body, req): Promise<{ profile: { altEmail: string; avatarUrl: string | null; bio: string; connectedAccounts: object[]; coverUrl: string | null; email: string; fullName: string; hasPassword: boolean; initials: string; linkedin: string; memberSince: string; organization: string; phone: string; signatureDataUrl: string | null; title: string; twoFactorEnabled: boolean; username: string; }; token: string; }>

Defined in: backends/web-backend/src/users/users.controller.ts:111

Parameters ​

body ​
currentPassword ​

string = ...

newEmail ​

string = ...

req ​

AuthenticatedRequest

Returns ​

Promise<{ profile: { altEmail: string; avatarUrl: string | null; bio: string; connectedAccounts: object[]; coverUrl: string | null; email: string; fullName: string; hasPassword: boolean; initials: string; linkedin: string; memberSince: string; organization: string; phone: string; signatureDataUrl: string | null; title: string; twoFactorEnabled: boolean; username: string; }; token: string; }>

changePassword() ​

changePassword(body, req): Promise<{ detail: string; }>

Defined in: backends/web-backend/src/users/users.controller.ts:129

Parameters ​

body ​
currentPassword ​

string = ...

newPassword ​

string = ...

req ​

AuthenticatedRequest

Returns ​

Promise<{ detail: string; }>

changeUsername() ​

changeUsername(body, req): Promise<{ profile: { altEmail: string; avatarUrl: string | null; bio: string; connectedAccounts: object[]; coverUrl: string | null; email: string; fullName: string; hasPassword: boolean; initials: string; linkedin: string; memberSince: string; organization: string; phone: string; signatureDataUrl: string | null; title: string; twoFactorEnabled: boolean; username: string; }; token: string; }>

Defined in: backends/web-backend/src/users/users.controller.ts:120

Parameters ​

body ​
newUsername ​

string = ...

req ​

AuthenticatedRequest

Returns ​

Promise<{ profile: { altEmail: string; avatarUrl: string | null; bio: string; connectedAccounts: object[]; coverUrl: string | null; email: string; fullName: string; hasPassword: boolean; initials: string; linkedin: string; memberSince: string; organization: string; phone: string; signatureDataUrl: string | null; title: string; twoFactorEnabled: boolean; username: string; }; token: string; }>

clearSignature() ​

clearSignature(req): Promise<{ signatureDataUrl: string | null; }>

Defined in: backends/web-backend/src/users/users.controller.ts:286

Parameters ​

req ​

AuthenticatedRequest

Returns ​

Promise<{ signatureDataUrl: string | null; }>

deleteAvatar() ​

deleteAvatar(req): Promise<{ altEmail: string; avatarUrl: string | null; bio: string; connectedAccounts: object[]; coverUrl: string | null; email: string; fullName: string; hasPassword: boolean; initials: string; linkedin: string; memberSince: string; organization: string; phone: string; signatureDataUrl: string | null; title: string; twoFactorEnabled: boolean; username: string; }>

Defined in: backends/web-backend/src/users/users.controller.ts:243

Parameters ​

req ​

AuthenticatedRequest

Returns ​

Promise<{ altEmail: string; avatarUrl: string | null; bio: string; connectedAccounts: object[]; coverUrl: string | null; email: string; fullName: string; hasPassword: boolean; initials: string; linkedin: string; memberSince: string; organization: string; phone: string; signatureDataUrl: string | null; title: string; twoFactorEnabled: boolean; username: string; }>

deleteCover() ​

deleteCover(req): Promise<{ altEmail: string; avatarUrl: string | null; bio: string; connectedAccounts: object[]; coverUrl: string | null; email: string; fullName: string; hasPassword: boolean; initials: string; linkedin: string; memberSince: string; organization: string; phone: string; signatureDataUrl: string | null; title: string; twoFactorEnabled: boolean; username: string; }>

Defined in: backends/web-backend/src/users/users.controller.ts:263

Parameters ​

req ​

AuthenticatedRequest

Returns ​

Promise<{ altEmail: string; avatarUrl: string | null; bio: string; connectedAccounts: object[]; coverUrl: string | null; email: string; fullName: string; hasPassword: boolean; initials: string; linkedin: string; memberSince: string; organization: string; phone: string; signatureDataUrl: string | null; title: string; twoFactorEnabled: boolean; username: string; }>

deleteMe() ​

deleteMe(body, req): Promise<void>

Defined in: backends/web-backend/src/users/users.controller.ts:220

Parameters ​

body ​
currentPassword ​

string

req ​

AuthenticatedRequest

Returns ​

Promise<void>

disableTwoFactor() ​

disableTwoFactor(body, req): Promise<{ detail: string; }>

Defined in: backends/web-backend/src/users/users.controller.ts:154

Parameters ​

body ​
code ​

string = TwoFactorCodeSchema

req ​

AuthenticatedRequest

Returns ​

Promise<{ detail: string; }>

disconnectProvider() ​

disconnectProvider(provider, req): Promise<{ altEmail: string; avatarUrl: string | null; bio: string; connectedAccounts: object[]; coverUrl: string | null; email: string; fullName: string; hasPassword: boolean; initials: string; linkedin: string; memberSince: string; organization: string; phone: string; signatureDataUrl: string | null; title: string; twoFactorEnabled: boolean; username: string; }>

Defined in: backends/web-backend/src/users/users.controller.ts:163

Parameters ​

provider ​

string

req ​

AuthenticatedRequest

Returns ​

Promise<{ altEmail: string; avatarUrl: string | null; bio: string; connectedAccounts: object[]; coverUrl: string | null; email: string; fullName: string; hasPassword: boolean; initials: string; linkedin: string; memberSince: string; organization: string; phone: string; signatureDataUrl: string | null; title: string; twoFactorEnabled: boolean; username: string; }>

enableTwoFactor() ​

enableTwoFactor(body, req): Promise<{ backupCodes: string[]; }>

Defined in: backends/web-backend/src/users/users.controller.ts:145

Parameters ​

body ​
code ​

string = TwoFactorCodeSchema

req ​

AuthenticatedRequest

Returns ​

Promise<{ backupCodes: string[]; }>

exportData() ​

exportData(req, res): Promise<void>

Defined in: backends/web-backend/src/users/users.controller.ts:171

Parameters ​

req ​

AuthenticatedRequest

res ​

Response

Returns ​

Promise<void>

getMe() ​

getMe(req): Promise<{ profile: { altEmail: string; avatarUrl: string | null; bio: string; connectedAccounts: object[]; coverUrl: string | null; email: string; fullName: string; hasPassword: boolean; initials: string; linkedin: string; memberSince: string; organization: string; phone: string; signatureDataUrl: string | null; title: string; twoFactorEnabled: boolean; username: string; }; projectCount: number; }>

Defined in: backends/web-backend/src/users/users.controller.ts:76

Parameters ​

req ​

AuthenticatedRequest

Returns ​

Promise<{ profile: { altEmail: string; avatarUrl: string | null; bio: string; connectedAccounts: object[]; coverUrl: string | null; email: string; fullName: string; hasPassword: boolean; initials: string; linkedin: string; memberSince: string; organization: string; phone: string; signatureDataUrl: string | null; title: string; twoFactorEnabled: boolean; username: string; }; projectCount: number; }>

getNotificationPrefs() ​

getNotificationPrefs(req): Promise<{ projectShared: boolean; quantErrors: boolean; runFinished: boolean; teamInvite: boolean; }>

Defined in: backends/web-backend/src/users/users.controller.ts:205

Parameters ​

req ​

AuthenticatedRequest

Returns ​

Promise<{ projectShared: boolean; quantErrors: boolean; runFinished: boolean; teamInvite: boolean; }>

getPublic() ​

getPublic(username): Promise<{ avatarUrl: string | null; bio: string; coverUrl: string | null; fullName: string; initials: string; linkedin: string; memberSince: string; organization: string; title: string; username: string; }>

Defined in: backends/web-backend/src/users/users.controller.ts:93

Parameters ​

username ​

string

Returns ​

Promise<{ avatarUrl: string | null; bio: string; coverUrl: string | null; fullName: string; initials: string; linkedin: string; memberSince: string; organization: string; title: string; username: string; }>

getSignature() ​

getSignature(req): Promise<{ signatureDataUrl: string | null; }>

Defined in: backends/web-backend/src/users/users.controller.ts:269

Parameters ​

req ​

AuthenticatedRequest

Returns ​

Promise<{ signatureDataUrl: string | null; }>

listSessions() ​

listSessions(req): Promise<{ sessions: object[]; }>

Defined in: backends/web-backend/src/users/users.controller.ts:182

Parameters ​

req ​

AuthenticatedRequest

Returns ​

Promise<{ sessions: object[]; }>

patchMe() ​

patchMe(body, req): Promise<{ profile: { altEmail: string; avatarUrl: string | null; bio: string; connectedAccounts: object[]; coverUrl: string | null; email: string; fullName: string; hasPassword: boolean; initials: string; linkedin: string; memberSince: string; organization: string; phone: string; signatureDataUrl: string | null; title: string; twoFactorEnabled: boolean; username: string; }; projectCount: number; }>

Defined in: backends/web-backend/src/users/users.controller.ts:99

Parameters ​

body ​
altEmail? ​

string = ...

bio? ​

string = ...

fullName? ​

string = ...

linkedin? ​

string = ...

organization? ​

string = ...

phone? ​

string = ...

title? ​

string = ...

req ​

AuthenticatedRequest

Returns ​

Promise<{ profile: { altEmail: string; avatarUrl: string | null; bio: string; connectedAccounts: object[]; coverUrl: string | null; email: string; fullName: string; hasPassword: boolean; initials: string; linkedin: string; memberSince: string; organization: string; phone: string; signatureDataUrl: string | null; title: string; twoFactorEnabled: boolean; username: string; }; projectCount: number; }>

revokeOtherSessions() ​

revokeOtherSessions(req): Promise<{ sessions: object[]; }>

Defined in: backends/web-backend/src/users/users.controller.ts:197

Parameters ​

req ​

AuthenticatedRequest

Returns ​

Promise<{ sessions: object[]; }>

revokeSession() ​

revokeSession(id, req): Promise<{ sessions: object[]; }>

Defined in: backends/web-backend/src/users/users.controller.ts:189

Parameters ​

id ​

string

req ​

AuthenticatedRequest

Returns ​

Promise<{ sessions: object[]; }>

saveSignature() ​

saveSignature(body, req): Promise<{ signatureDataUrl: string | null; }>

Defined in: backends/web-backend/src/users/users.controller.ts:275

Parameters ​

body ​
signatureDataUrl? ​

string

req ​

AuthenticatedRequest

Returns ​

Promise<{ signatureDataUrl: string | null; }>

search(req, q?): Promise<{ users: object[]; }>

Defined in: backends/web-backend/src/users/users.controller.ts:87

Parameters ​

req ​

AuthenticatedRequest

q? ​

string

Returns ​

Promise<{ users: object[]; }>

setupTwoFactor() ​

setupTwoFactor(req): Promise<{ otpauthUri: string; secret: string; }>

Defined in: backends/web-backend/src/users/users.controller.ts:139

Parameters ​

req ​

AuthenticatedRequest

Returns ​

Promise<{ otpauthUri: string; secret: string; }>

updateNotificationPrefs() ​

updateNotificationPrefs(body, req): Promise<{ projectShared: boolean; quantErrors: boolean; runFinished: boolean; teamInvite: boolean; }>

Defined in: backends/web-backend/src/users/users.controller.ts:211

Parameters ​

body ​
projectShared? ​

boolean = ...

quantErrors? ​

boolean = ...

runFinished? ​

boolean = ...

teamInvite? ​

boolean = ...

req ​

AuthenticatedRequest

Returns ​

Promise<{ projectShared: boolean; quantErrors: boolean; runFinished: boolean; teamInvite: boolean; }>

uploadAvatar() ​

uploadAvatar(file, req): Promise<{ altEmail: string; avatarUrl: string | null; bio: string; connectedAccounts: object[]; coverUrl: string | null; email: string; fullName: string; hasPassword: boolean; initials: string; linkedin: string; memberSince: string; organization: string; phone: string; signatureDataUrl: string | null; title: string; twoFactorEnabled: boolean; username: string; }>

Defined in: backends/web-backend/src/users/users.controller.ts:233

Parameters ​

file ​

UploadedImage | undefined

req ​

AuthenticatedRequest

Returns ​

Promise<{ altEmail: string; avatarUrl: string | null; bio: string; connectedAccounts: object[]; coverUrl: string | null; email: string; fullName: string; hasPassword: boolean; initials: string; linkedin: string; memberSince: string; organization: string; phone: string; signatureDataUrl: string | null; title: string; twoFactorEnabled: boolean; username: string; }>

uploadCover() ​

uploadCover(file, req): Promise<{ altEmail: string; avatarUrl: string | null; bio: string; connectedAccounts: object[]; coverUrl: string | null; email: string; fullName: string; hasPassword: boolean; initials: string; linkedin: string; memberSince: string; organization: string; phone: string; signatureDataUrl: string | null; title: string; twoFactorEnabled: boolean; username: string; }>

Defined in: backends/web-backend/src/users/users.controller.ts:253

Parameters ​

file ​

UploadedImage | undefined

req ​

AuthenticatedRequest

Returns ​

Promise<{ altEmail: string; avatarUrl: string | null; bio: string; connectedAccounts: object[]; coverUrl: string | null; email: string; fullName: string; hasPassword: boolean; initials: string; linkedin: string; memberSince: string; organization: string; phone: string; signatureDataUrl: string | null; title: string; twoFactorEnabled: boolean; username: string; }>