Bagikan melalui

WSFederationAuthenticationModule.CreateSignInRequest Metode

  • Referensi

Definisi

Ruang nama:
System.IdentityModel.Services
Rakitan:
System.IdentityModel.Services.dll

Membuat pesan permintaan masuk WS-Federation dengan menggunakan parameter WS-Federation yang dikonfigurasi pada modul.

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

Parameter

uniqueId
String

WSFAM menyimpan nilai ini dalam parameter wctx dalam permintaan masuk WS-Federation; namun, modul tidak menggunakannya saat memproses permintaan masuk atau respons masuk. Anda dapat mengaturnya ke nilai apa pun. Ini tidak harus unik.

returnUrl
String

URL yang harus dikembalikan modul saat autentikasi.

rememberMeSet
Boolean

WSFAM menyimpan nilai ini dalam parameter wctx dalam permintaan masuk WS-Federation; namun, modul tidak menggunakannya saat memproses permintaan masuk atau respons masuk. Anda dapat mengaturnya baik true atau false.

Mengembalikan

SignInRequestMessage

Pesan permintaan masuk WS-Federation.

Pengecualian

InvalidOperationException

Properti Issuer adalah null atau string kosong.

-atau-

Properti Realm adalah null atau string kosong.

Keterangan

Membuat permintaan masuk WS-Federation yang diwakili oleh SignInRequestMessage objek. Properti objek baru SignInRequestMessage diatur sebagai berikut:

  • Properti Context (parameter wctx) diatur ke nilai yang dibuat dengan menggunakan parameter metode.

  • Properti CurrentTime (parameter wct) diatur ke waktu saat ini.

  • Semua properti lain diatur dengan menggunakan properti yang setara dari instans saat ini.

Parameter yang diteruskan ke metode digunakan untuk membuat parameter pesan wctx. Ini adalah string dengan format berikut: ru=returnUrl&cx=SignInContext&rm=rememberMeSet&id=uniqueId.

  • Nilai ru diatur ke nilai parameter yang returnUrl diteruskan ke metode dan menentukan URL bahwa modul harus mengarahkan browser untuk mengikuti autentikasi yang berhasil. Ini adalah satu-satunya nilai yang disimpan dalam string wctx yang digunakan oleh WSFAM. Modul memanggil GetReturnUrlFromResponse metode untuk mengekstrak nilai ini dari parameter wctx saat memproses respons masuk WS-Federation. Ini tidak boleh dikacaukan dengan parameter pesan balasan, yang ditentukan oleh Reply properti dan yang memberikan alamat di RP tempat layanan token keamanan (STS) harus mengarahkan responsnya.

  • Parameter cx diatur ke nilai SignInContext properti . Properti ini diekspos untuk memungkinkan Anda mengatur konteks yang ditentukan aplikasi apa pun yang harus disimpan dalam string wctx; namun, WSFAM tidak mengekspos metode untuk mengekstrak nilai ini dalam respons. Jika nilai diperlukan oleh aplikasi Anda, Anda harus memberikan kode untuk mengurai string wctx dan membaca nilai ini saat memproses respons. Anda mungkin menyelesaikan ini dengan mengambil alih GetReturnUrlFromResponse metode .

  • rm Baik nilai, yang diatur ke nilai rememberMeSet parameter, maupun id parameter, yang diatur ke nilai uniqueId parameter yang digunakan oleh WSFAM. Ini dapat diatur ke nilai apa pun.

Metode CreateSignInRequest ini dipanggil dari RedirectToIdentityProvider metode .

Berlaku untuk

Lihat juga