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

Query Parameters
    redirect boolean

    by default, location redirect header for starting authentication flow if applicable will be skipped unless this is set to true, useful in browser

    If set to true, location header will be set for redirect

    returnTo string

    by default, after successful authentication no operation will be performed to apply redirection in case of browsers, provide a url that will be used for redirection after authentication

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

    email string

    email of the user for magic links

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

Responses

A successful response.

Schema
    endpoint string
    state string
Loading...