Early Preview
This is currently very much a preview. Please feel free to try things out,
but don't be upset if anything is not yet working. Feedback is welcome over on our
GitHub Dicussions page.
class Sustainsys.Saml2.Saml2P.Saml2AuthenticationRequest
Assembly: Sustainsys.Saml2
Inheritance: object → Saml2RequestBase → Saml2AuthenticationRequest
Implemented Interfaces
- ISaml2Message Implemented by: Saml2RequestBase
An authentication request corresponding to section 3.4.1 in SAML Core specification.
Properties
protected
string
LocalName
The SAML2 request name
public
System.Uri
AssertionConsumerServiceUrl
The assertion consumer url that the idp should send its response back to.
public
int?
AttributeConsumingServiceIndex
Index to the SP metadata where the list of requested attributes is found.
public
Saml2Scoping
Scoping
Scoping for request
public
Saml2NameIdPolicy
NameIdPolicy
NameId policy.
public
Saml2RequestedAuthnContext
RequestedAuthnContext
RequestedAuthnContext.
public
WebSso.Saml2BindingType?
Binding
Binding type to request the Idp to use when responding.
public
bool
ForceAuthentication
Sets whether request should force the idp to authenticate the presenter directly,
rather than rely on a previous security context.
If false, the ForceAuthn parameter is omitted from the request.
If true, the request is sent with ForceAuthn="true".
public
bool
IsPassive
Sets whether request should request for SAML Passive login if possible,
If false, the IsPassive parameter is omitted from the request.
If true, the request is sent with IsPassive="true".
The id of the request.
public
string
Version
Version of the SAML request. Always returns "2.0"
public
string
IssueInstant
The instant that the request was issued (well actually, created).
public
string
MessageName
SAML message name for requests - hard coded to SAMLRequest.
public
System.Uri
DestinationUrl
The destination of the request.
public
Metadata.EntityId
Issuer
The issuer of the request.
ExtensionContents
The additional content to append within an Extensions element.
public
string
RelayState
RelayState attached to the message.
SigningCertificate
Certificate used to sign the message with during binding, according
to the signature processing rules of each binding.
public
string
SigningAlgorithm
The signing algorithm to use when signing the message during binding,
according to the signature processing rules of each binding.
Methods
Returns XElement
public
string
ToXml()
Serializes the message into wellformed Xml
Returns string containing the Xml data.
public static
Saml2AuthenticationRequest
Read(string xml,
string relayState)
Read the supplied Xml and parse it into a authenticationrequest.
Returns Saml2Request
xml
xml data.
relayState
Relay State attached to the message or null if not present.
ToXNodes()
Inherited from Saml2RequestBase
Creates XNodes for the fields of the Saml2RequestBase class. These
nodes should be added when creating XML out of derived classes.
protected
void
ReadBaseProperties(System.Xml.XmlElement xml)
Inherited from Saml2RequestBase
Reads the request properties present in Saml2RequestBase
Also validates basic properties of the request
xml
The xml document to parse
public
bool
Equals(object obj)
Inherited from object
protected
void
Finalize()
Inherited from object
public
int
GetHashCode()
Inherited from object
protected
object
MemberwiseClone()
Inherited from object
public
string
ToString()
Inherited from object