LoginController.Get(String, String, String, String) Method

Definition

Handler for server login flows.

[System.Web.Http.AllowAnonymous]
[System.Web.Http.HostAuthentication("ExternalCookie")]
[System.Web.Http.OverrideAuthentication]
public System.Web.Http.IHttpActionResult Get (string authenticationProvider, string error = default, string completionType = default, string completionOrigin = default);
[<System.Web.Http.AllowAnonymous>]
[<System.Web.Http.HostAuthentication("ExternalCookie")>]
[<System.Web.Http.OverrideAuthentication>]
member this.Get : string * string * string * string -> System.Web.Http.IHttpActionResult
Public Function Get (authenticationProvider As String, Optional error As String = Nothing, Optional completionType As String = Nothing, Optional completionOrigin As String = Nothing) As IHttpActionResult

Parameters

authenticationProvider
String

The authentication provider to use for the login

error
String

The provider login error if an error occurred.

completionType
String

Completion type. Used only with html authentication.

completionOrigin
String

Completion origin. Used only with html authentication.

Returns

System.Web.Http.IHttpActionResult

If the login is successful, the method returns a LoginResult containing the login details. A 401 status code is returned otherwise.

Attributes
System.Web.Http.AllowAnonymousAttribute System.Web.Http.HostAuthenticationAttribute System.Web.Http.OverrideAuthenticationAttribute

Applies to