Skip to main content

Class: SelfRegisterUserInput

api-login/dto/user-inputs.dto.SelfRegisterUserInput

Input type for user self registration. Expects an additional register_token

Hierarchy

Constructors

constructor

new SelfRegisterUserInput()

Inherited from

BaseUserInput.constructor

Properties

displayName

displayName: string

The name to display in the UI for the new user. Must be given and can't be empty

Example

"Test User"

Inherited from

BaseUserInput.displayName

Defined in

login-service/src/api-login/dto/user-inputs.dto.ts:22


email

Optional email: string

The email of the new user. Can be ommitted, but if given can't be empty.

Example

"test-user@example.com"

Inherited from

BaseUserInput.email

Defined in

login-service/src/api-login/dto/user-inputs.dto.ts:30


register_token

register_token: string

The register token issued during as result of the oauth registration flow. Scope of the token must contain "login-register".

Must be given.

Example

"registration.token.jwt"

Defined in

login-service/src/api-login/dto/user-inputs.dto.ts:73


username

username: string

The username to set for the new user. Must be given and cannot be empty

Example

"testUser"

Inherited from

BaseUserInput.username

Defined in

login-service/src/api-login/dto/user-inputs.dto.ts:14

Methods

check

Static check(input): SelfRegisterUserInput

Checks for a valid SelfRegisterUserInput

Needed:

Parameters

NameTypeDescription
inputSelfRegisterUserInputThe instance to check

Returns

SelfRegisterUserInput

The argument unchanged

Throws

HttpException BAD_REQUEST if invalid

Overrides

BaseUserInput.check

Defined in

login-service/src/api-login/dto/user-inputs.dto.ts:86