Skip to main content

Authenticate with a strategy​

Authenticate a user with a strategy. By default, after successful authentication no operation will be performed to apply redirection in case of browsers, provide a url in the authenticate request body that will be used for redirection after authentication. Also set redirect as true for redirecting the user request to the redirect_url after successful authentication.

Path Parameters
    strategyName string required

    Name of the strategy to use for authentication.
    Example: google

Request Body required
    redirectOnstart by default, location redirect header for starting authentication flow if applicable will be skipped unless this is set to true, useful in browser, same value will also be returned as endpoint in response anyway

    If set to true, location header will be set for redirect to start auth flow

    returnTo by default, after successful authentication(flow completes) no operation will be performed, to apply redirection in case of browsers, provide an url that will be used after authentication where users are sent from frontier. return_to should be one of the allowed urls configured at instance level

    URL to redirect after successful authentication.
    Example:"https://frontier.example.com"

    email email of the user for magic links

    Email of the user to authenticate. Used for magic links.
    Example:example@acme.org

    callbackUrl callback_url will be used by strategy as last step to finish authentication flow in OIDC this host will receive "state" and "code" query params, in case of magic links this will be the url where user is redirected after clicking on magic link. For most cases it could be host of frontier but in case of proxies, this will be proxy public endpoint. callback_url should be one of the allowed urls configured at instance level

    Host which should handle the call to finish authentication flow, for most cases it could be host of frontier but in case of proxies, this will be proxy public endpoint.
    Example:https://frontier.example.com/v1beta1/auth/callback

Responses

A successful response.

Schema
    endpoint endpoint specifies the url to redirect user for starting authentication flow
    state state is used for resuming authentication flow in applicable strategies
    stateOptions object
Loading...