Skip to main content

List all strategy instances (of type)

GET 
/auth/api/login/strategy-instance

Gets the list of all Strategy instances. If a type is specified, only the instances of that type will be retrieved.

If a non existant strategy type name ist specified, no instances will be returned.

Request​

Path Parameters

    type string

    The strategy type name. If not given gets all instances

Responses​

The list of all strategy instances

Schema
  • Array [
    • id stringrequired

    The unique ID of this strategy instance

    name stringrequired

    An optional human readable name for the strategy.

    Can be displayes in a UI etc. but is not necesarrily unique.

    type stringrequired

    The unique string name of the strategy this is an instance of

    The strategy of an instance is set on initialization and cannot be changed

    isLoginActive booleanrequired

    If true, this strategy instance allows login of registered users to retrieve an access token. Additionally the strategy must have {@link Strategy.canLoginRegister} set to true

    If false, users are not allowed to login using this instance.

    isSelfRegisterActive booleanrequired

    If true users can create an account themselves with the registration token they obtained from this instance. This only affects registration, not linking an additional account. Additionally the strategy must have {@link Strategy.canLoginRegister} set to true

    If false accounts cannot be created without being admin.

    isSyncActive booleanrequired

    If true, and {@link Strategy.canSync} is true, the sync service can retrieve access tokens for ims users from this strategy instnce.

    If false, no tokens will be handed out for the instance

    doesImplicitRegister booleanrequired

    If true, a user automatically gets a registration token, if they tried to login and an account was not found but the user provided credentials (i.e. sucessfully authenticated with the 3rd party). Needs {@link Strategy.allowsImplicitSignup} to be true.

    If false, login fails if no known user was found.

  • ]
Loading...