WSFederationAuthenticationModule.Realm 属性

定义

获取或设置 WS 联合身份验证登录请求(“wsignin1.0”)中使用的 wtrealm 参数的值。Gets or sets the value of the wtrealm parameter to be used for WS-Federation sign-in requests ("wsignin1.0").

public:
 property System::String ^ Realm { System::String ^ get(); void set(System::String ^ value); };
public string Realm { get; set; }
member this.Realm : string with get, set
Public Property Realm As String

属性值

String

标识安全标志服务 (STS)的该依赖方 (RP) 的 URI。A URI that identifies the relying party (RP) to the security token service (STS).

例外

尝试将此属性设置为 null 或者空字符串。An attempt to set the property to null or an empty string occurs.

- 或 --or- 尝试设置这个属性为一个值,该值不是有效的绝对 URI。An attempt to set the property to a value that is not a valid, absolute URI occurs.

注解

这是 WS-Federation 登录请求的必需属性。This is a required property for WS-Federation sign-in requests. 如果启用了被动重定向,则必须设置该设置。It must be set if passive redirects are enabled. URI 将 RP 标识到 STS。The URI identifies the RP to the STS. (用于标识 RP 的 STS,请参阅 Issuer 属性) 。(For identifying the STS to the RP, see the Issuer property).

此属性的值将被序列化为 WS-Federation 协议中的 wtrealm 查询字符串参数。The value of this property is serialized as the wtrealm query string parameter in WS-Federation protocol. 它将 RP 标识到 STS。It identifies the RP to the STS. STS 使用它来确定要为令牌颁发应用的策略,以及在令牌颁发后要将用户重定向到的位置。It is used by the STS to decide what policy to apply for token issuance and where to redirect the user to after token issuance. (用于标识 RP 的 STS,请参阅 Issuer 。 ) (For identifying the STS to the RP, see Issuer.)

可以通过为事件添加处理程序,在每个 HTTP 请求上覆盖此设置 RedirectingToIdentityProviderYou can override this setting on each HTTP request by adding a handler for the RedirectingToIdentityProvider event. 此事件恰好在模块使用 WS-Federation 登录请求消息重定向到 security token service (STS) 之前引发。This event is raised just before the module redirects to the security token service (STS) with a WS-Federation sign-in request message. STS 由 Issuer 属性指定。The STS is specified by the Issuer property.

适用于