Class default

Classdesc

This class provides a controller for user-related operations.

Index

Constructors

Methods

get grantAdmin grantUser login logout logoutAll register

Constructors

constructor

new default(userService): default
Parameters
- userService: UserService
Returns default

Methods

get

get(): string
Endpoint for testing the service.

Returns string

grantAdmin

grantAdmin(payload): Promise<default<null>>
Endpoint for granting a user admin privileges.
Parameters
- payload: default
Returns Promise<default<null>>

grantUser

grantUser(payload): Promise<default<null>>
Endpoint for revoking a user's admin privileges.
Parameters
- payload: default
Returns Promise<default<null>>

login

login(payload): Promise<default<{
token: string;
user: TransformedUser;
}>>
Endpoint for logging in a user.
Parameters
- payload: default
Returns Promise<default<{
token: string;
user: TransformedUser;
}>>

logout

logout(payload): Promise<default<null>>
Endpoint for logging out a user.
Parameters
- payload: default
Returns Promise<default<null>>

logoutAll

logoutAll(payload): Promise<default<null>>
Endpoint for logging out a user from all sessions.
Parameters
- payload: default
Returns Promise<default<null>>

register

register(user): Promise<default<StrippedUser>>
Endpoint for registering a user.
Parameters
- user: default
Returns Promise<default<StrippedUser>>