WSFederationAuthenticationModule.CreateSignInRequest Метод
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Создает сообщение запроса входа 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
.
Возвращаемое значение
Сообщение запроса входа WS-Federation.
Исключения
Свойство 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 message, который задается свойством Reply и предоставляет адрес в RP, на который служба маркеров безопасности (STS) должна направлять свой ответ.Параметру
cx
присваивается значение SignInContext свойства . Это свойство предоставляется для настройки любого контекста, определяемого приложением, который должен храниться в строке wctx; однако WSFAM не предоставляет метод для извлечения этого значения в ответе. Если приложение требует значение, необходимо предоставить код для анализа строки wctx и чтения этого значения при обработке ответа. Это можно сделать, переопределив GetReturnUrlFromResponse метод .WSFAM
rm
не использует ни значение параметра, для которогоrememberMeSet
задано значение параметра, ниid
параметр, для которогоuniqueId
задано значение параметра. Для них можно задать любое значение.
Метод CreateSignInRequest вызывается из RedirectToIdentityProvider метода .
Применяется к
См. также раздел
Обратная связь
https://aka.ms/ContentUserFeedback.
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделеОтправить и просмотреть отзыв по