SignOnRequestParameters.Consent Property

  • Article

 

Gets or sets the consent identifier for an authentication request.

Namespace:   Microsoft.IdentityServer.Web
Assembly:  Microsoft.IdentityServer (in Microsoft.IdentityServer.dll)

Syntax

public Uri Consent { get; set; }

public:
property Uri^ Consent {
    Uri^ get();
    void set(Uri^ value);
}

member Consent : Uri with get, set

Public Property Consent As Uri

Property Value

Type: System.Uri

A Uri that identifies the method or conditions under which the consent of the principal was obtained for this request. The default is null, which is treated as “urn:oasis:names:tc:SAML:2.0:consent:unspecified”.

Remarks

The allowable consent identifiers are defined in section 8.4 of the SAML V2.0 Core specification on the SAML Specifications website.

The default implementations of IdpInitiatedSignOn.aspx and IdpInitiatedSignOn.aspx.cs in the Active Directory® Federation Services (AD FS) 2.0 Sign-In Pages provide a drop-down list that can be used to select a consent identifier for the request. By default, this list is disabled. To enable it, you must add the displayConsent key under the <appSettings> element in the web.config file. For more information, see Customizing the AD FS 2.0 Sign-In Pages Using Web.config.

You can modify IdpInitiatedSignOn.aspx.cs to provide support for specifying a consent identifier in the query string. For more information about customizing IdP-initiated sign-on with the SignOnRequestParameters class, see IdpInitiatedSignOnPage Class Overview. This topic also includes code samples.

See Also

SignOnRequestParameters Class
Microsoft.IdentityServer.Web Namespace
IdpInitiatedSignOnPage Class Overview

Return to top