WSFederationAuthenticationModule.GetFederationPassiveSignOutUrl Method

Definition

Namespace:

System.IdentityModel.Services

Assembly:

System.IdentityModel.Services.dll

Returns a URL that represents a WS-Federation sign-out request addressed to the specified issuer and that contains the specified wreply parameter and the specified additional parameters.

public:
 static System::String ^ GetFederationPassiveSignOutUrl(System::String ^ issuer, System::String ^ signOutReply, System::String ^ signOutQueryString);

public static string GetFederationPassiveSignOutUrl (string issuer, string signOutReply, string signOutQueryString);

static member GetFederationPassiveSignOutUrl : string * string * string -> string

Public Shared Function GetFederationPassiveSignOutUrl (issuer As String, signOutReply As String, signOutQueryString As String) As String

Parameters

issuer

String

The issuer address. The address of the security token service (STS) to which to direct the request.

signOutReply

String

A URL that specifies the address to return to after sign-out. This sets the wreply parameter in the sign-out request. Can be null or empty if no wreply parameter should be included in the generated sign-out request. This should be an absolute URI.

signOutQueryString

String

Additional query string parameters to be included in the sign-out request. Can be null or empty if no additional to be parameters included in the generated sign-out request. This should be a relative URI.

Returns

String

A URL that contains a WS-Federation passive sign-out request that is built by using the specified parameters.

Exceptions

ArgumentNullException

issuer is null.

Remarks

In the URL that is returned: the base URI is set to issuer; the wa parameter is set to "wsignout1.0"; the wreply parameter is set to signOutReply; and the parameters specified in signOutQueryString are present as additional query string parameters.