List all strategies/strategy types

GET 
/auth/api/login/strategy

Returns all known strategies (strategy types) that are registered in the system

Request

Responses

200

All known strategies in the system

application/json

Schema

Schema

• Array [
typeName stringrequired

The unique (type) name of the strategy

canLoginRegister booleanrequired

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

canSync booleanrequired

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

needsRedirectFlow booleanrequired

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

allowsImplicitSignup booleanrequired

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

acceptsVariables object[]required

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

updateActions object[]required

The actions that can be performed on the strategy instance

instanceConfigSchema objectrequired

The schema of the instance configuration

• ]

Example (from schema)

[
  {
    "typeName": "userpass",
    "canLoginRegister": true,
    "canSync": false,
    "needsRedirectFlow": false,
    "allowsImplicitSignup": false,
    "acceptsVariables": [
      {}
    ],
    "updateActions": [
      {}
    ],
    "instanceConfigSchema": {}
  }
]

Loading...