Бөлісу құралы:

WSFederationAuthenticationModule.CreateSignInRequest Метод

Определение

Пространство имен:
System.IdentityModel.Services
Сборка:
System.IdentityModel.Services.dll

Создает сообщение запроса WS-Federation входа с помощью параметров WS-Federation, настроенных в модуле.

public:
 System::IdentityModel::Services::SignInRequestMessage ^ CreateSignInRequest(System::String ^ uniqueId, System::String ^ returnUrl, bool rememberMeSet);
public System.IdentityModel.Services.SignInRequestMessage CreateSignInRequest(string uniqueId, string returnUrl, bool rememberMeSet);
member this.CreateSignInRequest : string * string * bool -> System.IdentityModel.Services.SignInRequestMessage
Public Function CreateSignInRequest (uniqueId As String, returnUrl As String, rememberMeSet As Boolean) As SignInRequestMessage

Параметры

uniqueId
String

WSFAM сохраняет это значение в параметре wctx в запросе на вход WS-Federation; Однако модуль не использует его при обработке запросов входа или ответов на вход. Его можно задать для любого значения. Это имя не обязательно должно быть уникальным.

returnUrl
String

URL-адрес, в который модуль должен вернуться при проверке подлинности.

rememberMeSet
Boolean

WSFAM сохраняет это значение в параметре wctx в запросе на вход WS-Federation; Однако модуль не использует его при обработке запросов входа или ответов на вход. Его можно задать true или false.

Возвращаемое значение

SignInRequestMessage

Сообщение запроса на вход WS-Federation.

Исключения

InvalidOperationException

Свойство Issuer является null или пустой строкой.

–или–

Свойство Realm является null или пустой строкой.

Комментарии

Создает запрос на вход WS-Federation, представленный SignInRequestMessage объектом. Свойства нового SignInRequestMessage объекта задаются следующим образом:

  • Свойство Context (параметр wctx) имеет значение, созданное с помощью параметров метода.

  • Для CurrentTime свойства (параметра wct) задано текущее время.

  • Все остальные свойства задаются с помощью эквивалентных свойств текущего экземпляра.

Параметры, передаваемые методу, используются для создания параметра сообщения wctx. Это строка со следующим форматом: ru=returnUrl&cx=SignInContext&rm=rememberMeSet&id=uniqueId

  • Значение ru задается значением returnUrl параметра, переданного методу, и указывает URL-адрес, который модуль должен направлять браузеру в соответствии с успешной проверкой подлинности. Это единственное значение, хранящееся в строке wctx, используемой WSFAM. Модуль вызывает GetReturnUrlFromResponse метод для извлечения этого значения из параметра wctx при обработке ответа WS-Federation входа. Не следует путать с параметром сообщения wreply, который указывается Reply свойством и который предоставляет адрес в RP, к которому служба маркеров безопасности (STS) должна направлять свой ответ.

  • Параметр cx имеет значение SignInContext свойства. Это свойство предоставляется, чтобы вы могли задать любой контекст, определенный приложением, который должен храниться в строке wctx; однако WSFAM не предоставляет метод для извлечения этого значения в ответе. Если для приложения требуется значение, необходимо предоставить код для анализа строки wctx и считывания этого значения при обработке ответа. Это можно сделать, переопределив GetReturnUrlFromResponse метод.

  • rm Ни значение, которое не задано rememberMeSet значением параметра, либо id параметром, который имеет значение uniqueId параметра, используется WSFAM. Их можно задать для любого значения.

Метод CreateSignInRequest вызывается из RedirectToIdentityProvider метода.

Применяется к

См. также раздел