a575963da9
Former-commit-id: da6be194a6b1221998fc28233f2503bd61dd9d14
196 lines
11 KiB
XML
196 lines
11 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<Type Name="IssuedTokenClientCredential" FullName="System.ServiceModel.Security.IssuedTokenClientCredential">
|
|
<TypeSignature Language="C#" Value="public sealed class IssuedTokenClientCredential" />
|
|
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit IssuedTokenClientCredential extends System.Object" />
|
|
<AssemblyInfo>
|
|
<AssemblyName>System.ServiceModel</AssemblyName>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Base>
|
|
<BaseTypeName>System.Object</BaseTypeName>
|
|
</Base>
|
|
<Interfaces />
|
|
<Docs>
|
|
<remarks>To be added.</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Represents information used to obtain an issued token from a security token service.</para>
|
|
</summary>
|
|
</Docs>
|
|
<Members>
|
|
<Member MemberName="CacheIssuedTokens">
|
|
<MemberSignature Language="C#" Value="public bool CacheIssuedTokens { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance bool CacheIssuedTokens" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets a Boolean that specifies whether issued tokens are to be cached by the channel.</para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="DefaultKeyEntropyMode">
|
|
<MemberSignature Language="C#" Value="public System.ServiceModel.Security.SecurityKeyEntropyMode DefaultKeyEntropyMode { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.ServiceModel.Security.SecurityKeyEntropyMode DefaultKeyEntropyMode" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.ServiceModel.Security.SecurityKeyEntropyMode</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>When the client does WS-Trust exchange with the Security Token Service to obtain the issued token, it sometimes must exchange key entropy with the Security Token Service to arrive at a shared symmetric key. The Security Token Service typically specifies the entropy exchange mechanism to use in its binding. If no such mechanism is specified in the Security Token Service's binding, the DefaultKeyEntropyMode value is used to exchange entropy with the Security Token Service.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the default value of <see cref="T:System.ServiceModel.Security.SecurityKeyEntropyMode" />.</para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="IssuedTokenRenewalThresholdPercentage">
|
|
<MemberSignature Language="C#" Value="public int IssuedTokenRenewalThresholdPercentage { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance int32 IssuedTokenRenewalThresholdPercentage" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The client caches issued tokens and when a cached issued token is going to expire in the near future, the client automatically gets a fresh issued token from the Security Token Service. The value of this property determines what percentage of the cached issued token's validity period must be over before getting a fresh issued token. </para>
|
|
<para>For example, if this property's value is 60, and the client gets an issued token that is valid for 100 minutes, it reuses the cached issued token for 60 minutes, after which it gets a fresh issued token from the Security Token Service.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the renewal threshold percentage for issued tokens.</para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="IssuerChannelBehaviors">
|
|
<MemberSignature Language="C#" Value="public System.Collections.Generic.Dictionary<Uri,System.Collections.Generic.KeyedByTypeCollection<System.ServiceModel.Description.IEndpointBehavior>> IssuerChannelBehaviors { get; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.Dictionary`2<class System.Uri, class System.Collections.Generic.KeyedByTypeCollection`1<class System.ServiceModel.Description.IEndpointBehavior>> IssuerChannelBehaviors" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Collections.Generic.Dictionary<System.Uri,System.Collections.Generic.KeyedByTypeCollection<System.ServiceModel.Description.IEndpointBehavior>></ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The dictionary keys are the URIs of the Security Token Services that the client wants to communicate with. The entry for each URI is a <see cref="T:System.Collections.Generic.KeyedByTypeCollection`1" /> of the endpoint behaviors that the application uses in the channels created by indigo2 to get the issued tokens from the Security Token Services.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets a collection of issuer channel behaviors.</para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="LocalIssuerAddress">
|
|
<MemberSignature Language="C#" Value="public System.ServiceModel.EndpointAddress LocalIssuerAddress { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance class System.ServiceModel.EndpointAddress LocalIssuerAddress" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.ServiceModel.EndpointAddress</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>When obtaining an issued token from a Security Token Service, the client application must be configured with the address of the Security Token Service. This information can be specified by the target service in its security policy. In case the target service does not specify this information in its security policy, the client's indigo2 channel uses the LocalIssuerAddress as the address of the Security Token Service from which to obtain the issued token.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the address of the local issuer.</para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="LocalIssuerBinding">
|
|
<MemberSignature Language="C#" Value="public System.ServiceModel.Channels.Binding LocalIssuerBinding { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance class System.ServiceModel.Channels.Binding LocalIssuerBinding" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.ServiceModel.Channels.Binding</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>When obtaining an issued token from a Security Token Service, the client application must be configured with the binding to use to communicate with the Security Token Service. In case the target service does not specify information about the Security Token Service in its security policy, the client's indigo2 channel uses the LocalIssuerBinding as the binding to use to communicate with the Security Token Service.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the binding of the local issuer.</para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="LocalIssuerChannelBehaviors">
|
|
<MemberSignature Language="C#" Value="public System.Collections.Generic.KeyedByTypeCollection<System.ServiceModel.Description.IEndpointBehavior> LocalIssuerChannelBehaviors { get; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.KeyedByTypeCollection`1<class System.ServiceModel.Description.IEndpointBehavior> LocalIssuerChannelBehaviors" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Collections.Generic.KeyedByTypeCollection<System.ServiceModel.Description.IEndpointBehavior></ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>This is a <see cref="T:System.Collections.Generic.KeyedByTypeCollection`1" /> of the endpoint behaviors that the application uses in the channels created by indigo2 to get the issued tokens from the local Security Token Service.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets a collection of local issuer channel behaviors.</para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="MaxIssuedTokenCachingTime">
|
|
<MemberSignature Language="C#" Value="public TimeSpan MaxIssuedTokenCachingTime { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan MaxIssuedTokenCachingTime" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.TimeSpan</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>By default, issued tokens obtained from the Security Token Service are cached by the indigo2 client channel. This property enables the application to specify the maximum time that the channel caches the issued token. </para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the maximum caching time for an issued token.</para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
</Members>
|
|
</Type> |