IAuthenticationManager.SignIn Method

 

Handles the sign-in process during authentication.

Namespace:   Microsoft.Owin.Security
Assembly:  Microsoft.Owin (in Microsoft.Owin.dll)

Overload List

	Name	Description
	SignIn(AuthenticationProperties, ClaimsIdentity[])	Add information to the response environment that will cause the appropriate authentication middleware to grant a claims-based identity to the recipient of the response. The exact mechanism of this may vary. Examples include setting a cookie, to adding a fragment on the redirect url, or producing an OAuth2 access code or token response.
	SignIn(ClaimsIdentity[])	Add information to the response environment that will cause the appropriate authentication middleware to grant a claims-based identity to the recipient of the response. The exact mechanism of this may vary. Examples include setting a cookie, to adding a fragment on the redirect url, or producing an OAuth2 access code or token response.

See Also

IAuthenticationManager Interface
Microsoft.Owin.Security Namespace

Return to top

IAuthenticationManager.SignIn Method (AuthenticationProperties, ClaimsIdentity[])

Add information to the response environment that will cause the appropriate authentication middleware to grant a claims-based identity to the recipient of the response. The exact mechanism of this may vary. Examples include setting a cookie, to adding a fragment on the redirect url, or producing an OAuth2 access code or token response.

Syntax

void SignIn(
    AuthenticationProperties properties,
    params ClaimsIdentity[] identities
)

void SignIn(
    AuthenticationProperties^ properties,
    ... array<ClaimsIdentity^>^ identities
)

abstract SignIn : 
        properties:AuthenticationProperties *
        [<ParamArrayAttribute>] identities:ClaimsIdentity[] -> unit

Sub SignIn (
    properties As AuthenticationProperties,
    ParamArray identities As ClaimsIdentity()
)

Parameters

• properties
  Type: Microsoft.Owin.Security.AuthenticationProperties

  Contains additional properties the middleware are expected to persist along with the claims. These values will be returned as the AuthenticateResult.properties collection when AuthenticateAsync is called on subsequent requests.

• identities
  Type: System.Security.Claims.ClaimsIdentity[]

  Determines which claims are granted to the signed in user. The ClaimsIdentity.AuthenticationType property is compared to the middleware's Options.AuthenticationType value to determine which claims are granted by which middleware. The recommended use is to have a single ClaimsIdentity which has the AuthenticationType matching a specific middleware.

Return to top

IAuthenticationManager.SignIn Method (ClaimsIdentity[])

Add information to the response environment that will cause the appropriate authentication middleware to grant a claims-based identity to the recipient of the response. The exact mechanism of this may vary. Examples include setting a cookie, to adding a fragment on the redirect url, or producing an OAuth2 access code or token response.

Syntax

void SignIn(
    params ClaimsIdentity[] identities
)

void SignIn(
    ... array<ClaimsIdentity^>^ identities
)

abstract SignIn : 
        [<ParamArrayAttribute>] identities:ClaimsIdentity[] -> unit

Sub SignIn (
    ParamArray identities As ClaimsIdentity()
)

Parameters

• identities
  Type: System.Security.Claims.ClaimsIdentity[]

  Determines which claims are granted to the signed in user. The ClaimsIdentity.AuthenticationType property is compared to the middleware's Options.AuthenticationType value to determine which claims are granted by which middleware. The recommended use is to have a single ClaimsIdentity which has the AuthenticationType matching a specific middleware.

Return to top