WSFederationAuthenticationModule.CreateSignInRequest Método

Definição

Espaço de Nomes:
System.IdentityModel.Services
Assemblagem:
System.IdentityModel.Services.dll

Cria uma mensagem de pedido de WS-Federation de início de sessão usando os parâmetros de WS-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 guarda este valor no parâmetro wctx no pedido de início de sessão WS-Federation; no entanto, o módulo não o utiliza ao processar pedidos ou respostas de início de sessão. Podes definir para qualquer valor. Não tem de ser único.

returnUrl
String

O URL ao qual o módulo deve regressar após a autenticação.

rememberMeSet
Boolean

O WSFAM guarda este valor no parâmetro wctx no pedido de início de sessão WS-Federation; no entanto, o módulo não o utiliza ao processar pedidos ou respostas de início de sessão. Pode defini-lo ou true .false

Devoluções

SignInRequestMessage

A WS-Federation mensagem de pedido de entrada.

Exceções

InvalidOperationException

A Issuer propriedade é null ou uma cadeia vazia.

-ou-

A Realm propriedade é null ou uma cadeia vazia.

Observações

Cria um pedido de início de sessão WS-Federation que é representado por um SignInRequestMessage objeto. As propriedades do novo SignInRequestMessage objeto são definidas da seguinte forma:

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

  • A CurrentTime propriedade (o parâmetro wct) é definida para o tempo atual.

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

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

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

  • O cx parâmetro é definido para o valor da SignInContext propriedade. Esta propriedade é exposta para permitir definir qualquer contexto definido pela aplicação que deva ser armazenado na string wctx; no entanto, o WSFAM não expõe um método para extrair este valor na resposta. Se o valor for necessário pela sua aplicação, deve fornecer o código para analisar a cadeia wctx e ler esse valor ao processar a resposta. Pode conseguir isto sobreescrevendo o GetReturnUrlFromResponse método.

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

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

Aplica-se a

Ver também