WSFederationAuthenticationModule.CreateSignInRequest Método

Definição

Namespace:

System.IdentityModel.Services

Assembly:

System.IdentityModel.Services.dll

Cria uma entrada do Web Services Federation na mensagem de solicitação usando os parâmetros do Web Services Federation configurados no módulo.

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

Parâmetros

uniqueId

String

O WSFAM salva esse valor no parâmetro wctx na solicitação de entrada do Web Services Federation, no entanto, o módulo não o utiliza ao processar solicitações de entrada ou respostas de entrada. Você pode defini-lo para qualquer valor. Não precisa ser exclusivo.

returnUrl

String

A URL para a qual o módulo deve retornar após a autenticação.

rememberMeSet

Boolean

O WSFAM salva esse valor no parâmetro wctx na solicitação de entrada do Web Services Federation, no entanto, o módulo não o utiliza ao processar solicitações de entrada ou respostas de entrada. É possível defini-lo como true ou false.

Retornos

SignInRequestMessage

A mensagem de solicitação de entrada do Web Services Federation.

Exceções

InvalidOperationException

A propriedade Issuer é null ou uma cadeia de caracteres vazia.

- ou -

A propriedade Realm é null ou uma cadeia de caracteres vazia.

Comentários

Cria uma solicitação de entrada WS-Federation representada por um SignInRequestMessage objeto . As propriedades do novo SignInRequestMessage objeto são definidas da seguinte maneira:

• A Context propriedade (o parâmetro wctx) é definida como um valor criado usando os parâmetros de método.

• A CurrentTime propriedade (o parâmetro wct) é definida como a hora atual.

• Todas as outras propriedades são definidas usando as propriedades equivalentes da instância atual.

Os parâmetros passados para o método são usados para criar o parâmetro de mensagem wctx. Essa é uma cadeia de caracteres com o seguinte formato: ru=returnUrl&cx=SignInContext&rm=rememberMeSet&id=uniqueId.

• O ru valor é definido como o valor do returnUrl parâmetro passado para o método e especifica a URL para a qual o módulo deve direcionar o navegador para a autenticação bem-sucedida. Esse é o único valor armazenado na cadeia de caracteres wctx usada pelo WSFAM. O módulo chama o GetReturnUrlFromResponse método para extrair esse valor do parâmetro wctx ao processar uma resposta de entrada WS-Federation. Ele não deve ser confundido com o parâmetro wreply message, que é especificado pela Reply propriedade e que fornece o endereço no RP para o qual o STS (serviço de token de segurança) deve direcionar sua resposta.

• O cx parâmetro é definido como o valor da SignInContext propriedade . Essa propriedade é exposta para permitir que você defina qualquer contexto definido pelo aplicativo que deve ser armazenado na cadeia de caracteres wctx; no entanto, o WSFAM não expõe um método para extrair esse valor na resposta. Se o valor for necessário para seu aplicativo, você deverá fornecer o código para analisar a cadeia de caracteres wctx e ler esse valor ao processar a resposta. Você pode fazer isso substituindo o GetReturnUrlFromResponse método .

• Nem o rm valor, que é definido como o valor do rememberMeSet parâmetro, nem o id parâmetro , que é definido como o valor do uniqueId parâmetro são usados pelo WSFAM. Eles podem ser definidos como qualquer valor.

O CreateSignInRequest método é chamado do RedirectToIdentityProvider método .

Confira também

• RedirectToIdentityProvider(String, String, Boolean)