Skip to main content

Class: UpdateStrategyInstanceInput

api-login/strategy/dto/update-strategy-instance.dto.UpdateStrategyInstanceInput

Input data type for modifying an existing user

Hierarchy​

Constructors​

constructor​

• new UpdateStrategyInstanceInput()

Properties​

doesImplicitRegister​

• Optional doesImplicitRegister: boolean

Set whether, the instance will implicitly register on a unknown login. Can only be true, if Strategy.allowsImplicitSignup (default value)

Example

false

Defined in​

gropius-login-service/backend/src/api-login/strategy/dto/update-strategy-instance.dto.ts:56

instanceConfig​

• instanceConfig: object

The data required by the strategy to configure the instance.

For example: the client id and secret for an oauth strategy

Example

{"clientId": "1234", "clientSecret": "secret"}

Defined in​

gropius-login-service/backend/src/api-login/strategy/dto/update-strategy-instance.dto.ts:24

isLoginActive​

• Optional isLoginActive: boolean

Set wehter, login should be active on the new strategy Can only be true, if Strategy.canLoginRegister (default value)

Example

true

Defined in​

gropius-login-service/backend/src/api-login/strategy/dto/update-strategy-instance.dto.ts:32

isSelfRegisterActive​

• Optional isSelfRegisterActive: boolean

Set whether, user self registration should be active on the new strategy Can only be true, if Strategy.canLoginRegister (default value)

Example

true

Defined in​

gropius-login-service/backend/src/api-login/strategy/dto/update-strategy-instance.dto.ts:40

isSyncActive​

• Optional isSyncActive: boolean

Set whether, providing sync tokens should be active on the new strategy Can only be true, if Strategy.canSync (default value)

Example

false

Defined in​

gropius-login-service/backend/src/api-login/strategy/dto/update-strategy-instance.dto.ts:48

name​

• Optional name: string

The name for the strategy instance to create. Can be left out.

If given, must be a non empty string

Exmple

"userpass-local"

Defined in​

gropius-login-service/backend/src/api-login/strategy/dto/update-strategy-instance.dto.ts:15

Methods​

check​

▸ Static check(input): UpdateStrategyInstanceInput

Checks, input is a valid UpdateStrategyInstanceInput

Needs:

  • If name is given, must be non empty
  • If instanceConfig is given it must be an object
  • If any of the flags is given it must be a valid boolean

Parameters​

NameTypeDescription
inputUpdateStrategyInstanceInputThe original input data to be checked

Returns​

UpdateStrategyInstanceInput

If successful, the input data

Defined in​

gropius-login-service/backend/src/api-login/strategy/dto/update-strategy-instance.dto.ts:69