Skip to main content

Get one strategy instance

GET 
/login/strategy/:type/instance/:id

Gets one strategy instance by the specified id. If the type is specified, only instances of that type will be looked at

Request​

Path Parameters

    id uuidrequired

    The uuid string of an existing strategy instance to get

    type stringrequired

    The strategy type name of which to search for the instance. Defaults to all types

Responses​

The requested strategy instance wiht additional data for its use

Schema
    id stringrequired

    {@link StrategyInstance.id}

    name stringnullablerequired

    {@link StrategyInstance.name}

    type stringrequired

    {@link StrategyInstance.type}

    isLoginActive booleanrequired

    {@link StrategyInstance.isLoginActive}

    isSelfRegisterActive booleanrequired

    {@link StrategyInstance.isSelfRegisterActive}

    isSyncActive booleanrequired

    {@link StrategyInstance.isSyncActive}

    doesImplicitRegister booleanrequired

    {@link StrategyInstance.doesImplicitRegister}

    urls object
    postLogin string

    The url to post credentials to, to log in using this strategy instance.

    Additionally `grant_type? must be set to "password" and the client must authenticate

    postRegister string

    The url to post credentials to, to register or link without sync using this strategy instance.

    Additionally `grant_type? must be set to "password" and the client must authenticate

    postRegisterSync string

    The url to post credentials to, to register or link with avtivated sync functionality

    Additionally `grant_type? must be set to "password" and the client must authenticate

    redirectLogin stringrequired

    The url to redirect the user to, to log in using this strategy

    On the request, the query parameter client_id must be set

    redirectRegister stringrequired

    The url to redirect the user to, to register or link without sync using this strategy instance.

    On the request, the query parameter client_id must be set

    redirectRegisterSync stringrequired

    The url to redirect the user to, to register or link with avtivated sync functionality

    On the request, the query parameter client_id must be set

Loading...