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: StrategyVariable[]

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

Defined in​

gropius-login-service/backend/src/api-login/strategy/dto/strategy-api.dto.ts:51

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​

gropius-login-service/backend/src/api-login/strategy/dto/strategy-api.dto.ts:45

canLoginRegister​

• canLoginRegister: boolean

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

Example

true

Defined in​

gropius-login-service/backend/src/api-login/strategy/dto/strategy-api.dto.ts:20

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​

gropius-login-service/backend/src/api-login/strategy/dto/strategy-api.dto.ts:28

instanceConfigSchema​

• instanceConfigSchema: Record<string, Schema>

The schema of the instance configuration

Defined in​

gropius-login-service/backend/src/api-login/strategy/dto/strategy-api.dto.ts:61

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​

gropius-login-service/backend/src/api-login/strategy/dto/strategy-api.dto.ts:37

typeName​

• typeName: string

The unique (type) name of the strategy

Example

"userpass"

Defined in​

gropius-login-service/backend/src/api-login/strategy/dto/strategy-api.dto.ts:13

updateActions​

• updateActions: StrategyUpdateAction[]

The actions that can be performed on the strategy instance

Defined in​

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