Skip to main content

Class: GetStrategyResponse

api-login/strategy/dto/strategy-api.dto.GetStrategyResponse

Representation of a strategy in the API

Constructors​

constructor​

• new GetStrategyResponse()

Properties​

acceptsVariables​

• acceptsVariables: Object

The specification of the data expected in the post body if not using redirect and sending the credentials directly to the token endpoint

Index signature​

▪ [key: string]: StrategyVariable

Defined in​

login-service/src/api-login/strategy/dto/strategy-api.dto.ts:50

allowsImplicitSignup​

• allowsImplicitSignup: boolean

true iff this strategy allows instances to use implicit signup to register users automatically if they don't have an account but tried to login

Example

false

Defined in​

login-service/src/api-login/strategy/dto/strategy-api.dto.ts:44

canLoginRegister​

• canLoginRegister: boolean

true iff instances of this strategy have the theoretical capability of logging in users

Example

true

Defined in​

login-service/src/api-login/strategy/dto/strategy-api.dto.ts:19

canSync​

• canSync: boolean

true iff instances of this strategy have the theoretical capability of providing api tokens to the a sync service

Example

false

Defined in​

login-service/src/api-login/strategy/dto/strategy-api.dto.ts:27

needsRedirectFlow​

• needsRedirectFlow: boolean

true if to authenticate using this strategy, a redirect of the users browser is required

false if sending credentials to the token endpoint is enough

Example

false

Defined in​

login-service/src/api-login/strategy/dto/strategy-api.dto.ts:36

typeName​

• typeName: string

The unique (type) name of the strategy

Example

"userpass"

Defined in​

login-service/src/api-login/strategy/dto/strategy-api.dto.ts:12