Class SamlProviderEvents

Events associated with SAML SSO and SLO.

Inheritance

System.Object

SamlProviderEvents

SamlIdentityProviderEvents

SamlServiceProviderEvents

Implements

ISamlProviderEvents

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: ComponentSpace.Saml2.Events

Assembly: ComponentSpace.Saml2.dll

Syntax

public abstract class SamlProviderEvents : ISamlProviderEvents

Properties

OnArtifactResolveCreated

Gets or sets the optional delegate called when a SAML artifact resolve request has been created.

Declaration

public Func<HttpContext, ArtifactResolve, ArtifactResolve> OnArtifactResolveCreated { get; set; }

Property Value

Type	Description
System.Func<Microsoft.AspNetCore.Http.HttpContext, ArtifactResolve, ArtifactResolve>	The delegate called when a SAML artifact resolve request has been created.

Remarks

The SAML artifact resolve request may be modified if required.

OnArtifactResolveReceived

Gets or sets the optional delegate called when a SAML artifact resolve request has been received.

Declaration

public Action<HttpContext, ArtifactResolve> OnArtifactResolveReceived { get; set; }

Property Value

Type	Description
System.Action<Microsoft.AspNetCore.Http.HttpContext, ArtifactResolve>	The delegate called when a SAML artifact resolve request has been received.

OnArtifactResponseCreated

Gets or sets the optional delegate called when a SAML artifact response has been created.

Declaration

public Func<HttpContext, ArtifactResponse, ArtifactResponse> OnArtifactResponseCreated { get; set; }

Property Value

Type	Description
System.Func<Microsoft.AspNetCore.Http.HttpContext, ArtifactResponse, ArtifactResponse>	The delegate called when a SAML artifact response has been created.

Remarks

The SAML artifact response may be modified if required.

OnArtifactResponseReceived

Gets or sets the optional delegate called when a SAML artifact response has been received.

Declaration

public Action<HttpContext, ArtifactResponse> OnArtifactResponseReceived { get; set; }

Property Value

Type	Description
System.Action<Microsoft.AspNetCore.Http.HttpContext, ArtifactResponse>	The delegate called when a SAML artifact response has been received.

OnLogoutRequestCreated

Gets or sets the optional delegate called when a SAML logout request has been created.

Declaration

public Func<HttpContext, LogoutRequest, LogoutRequest> OnLogoutRequestCreated { get; set; }

Property Value

Type	Description
System.Func<Microsoft.AspNetCore.Http.HttpContext, LogoutRequest, LogoutRequest>	The delegate called when a SAML logout request has been created.

Remarks

The SAML logout request may be modified if required.

OnLogoutRequestReceived

Gets or sets the optional delegate called when a SAML logout request has been received.

Declaration

public Action<HttpContext, LogoutRequest, string> OnLogoutRequestReceived { get; set; }

Property Value

Type	Description
System.Action<Microsoft.AspNetCore.Http.HttpContext, LogoutRequest, System.String>	The delegate called when a SAML logout request has been received.

OnLogoutResponseCreated

Gets or sets the optional delegate called when a SAML logout response has been created.

Declaration

public Func<HttpContext, LogoutResponse, LogoutResponse> OnLogoutResponseCreated { get; set; }

Property Value

Type	Description
System.Func<Microsoft.AspNetCore.Http.HttpContext, LogoutResponse, LogoutResponse>	The delegate called when a SAML logout response has been created.

Remarks

The SAML logout response may be modified if required.

OnLogoutResponseReceived

Gets or sets the optional delegate called when a SAML logout response has been received.

Declaration

public Action<HttpContext, LogoutResponse, string> OnLogoutResponseReceived { get; set; }

Property Value

Type	Description
System.Action<Microsoft.AspNetCore.Http.HttpContext, LogoutResponse, System.String>	The delegate called when a SAML logout response has been received.

OnReceiveMessage

Gets or sets the optional delegate called when receiving a SAML message.

Declaration

public Func<HttpContext, XmlElement, XmlElement> OnReceiveMessage { get; set; }

Property Value

Type	Description
System.Func<Microsoft.AspNetCore.Http.HttpContext, System.Xml.XmlElement, System.Xml.XmlElement>	The delegate called when receiving a SAML message.

Remarks

The SAML message may be modified if required.

OnResolveUrl

Gets or sets the optional delegate called to resolve the destination URL when sending a SAML message.

Declaration

public Func<HttpContext, SamlEndpointType, string, string> OnResolveUrl { get; set; }

Property Value

Type	Description
System.Func<Microsoft.AspNetCore.Http.HttpContext, SamlEndpointType, System.String, System.String>	The delegate called to resolve the destination URL when sending a SAML message.

Remarks

The URL may be modified if required.

OnSendMessage

Gets or sets the optional delegate called when sending a SAML message.

Declaration

public Func<HttpContext, XmlElement, XmlElement> OnSendMessage { get; set; }

Property Value

Type	Description
System.Func<Microsoft.AspNetCore.Http.HttpContext, System.Xml.XmlElement, System.Xml.XmlElement>	The delegate called when sending a SAML message.

Remarks

The SAML message may be modified if required.

Implements

ISamlProviderEvents