ClaimsSettings Class

 

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

Contains the settings for claims based authentication using Active Directory Federation Services 2.0 (AD FS 2.0).

Namespace:   Microsoft.Xrm.Sdk.Deployment
Assembly:  Microsoft.Xrm.Sdk.Deployment (in Microsoft.Xrm.Sdk.Deployment.dll)

Inheritance Hierarchy

System.Object
  Microsoft.Xrm.Sdk.Deployment.DeploymentObject
    Microsoft.Xrm.Sdk.Deployment.DeploymentConfigSettings
      Microsoft.Xrm.Sdk.Deployment.ClaimsSettingsBase
        Microsoft.Xrm.Sdk.Deployment.ClaimsSettings

Syntax

[DataContractAttribute(Name = "ClaimsSettings", Namespace = "http://schemas.microsoft.com/xrm/2011/Contracts/Deployment")]
public class ClaimsSettings : ClaimsSettingsBase
<DataContractAttribute(Name := "ClaimsSettings", Namespace := "http://schemas.microsoft.com/xrm/2011/Contracts/Deployment")>
Public Class ClaimsSettings
    Inherits ClaimsSettingsBase

Constructors

Name Description
System_CAPS_pubmethod ClaimsSettings()

Initializes a new instance of the ClaimsSettings class.

Properties

Name Description
System_CAPS_pubproperty Enabled

Gets or sets whether the setting is enabled.(Inherited from ClaimsSettingsBase.)

System_CAPS_pubproperty EncryptionCertificate

Gets or sets the encryption certificate.(Inherited from ClaimsSettingsBase.)

System_CAPS_pubproperty ExtensionData

Gets or sets the structure that contains extra data.(Inherited from DeploymentObject.)

System_CAPS_pubproperty FederationMetadataUrl

Gets or sets the federation metadata URL.(Inherited from ClaimsSettingsBase.)

System_CAPS_pubproperty FederationProviderType

Gets or sets the federation provider type.(Inherited from ClaimsSettingsBase.)

System_CAPS_pubproperty SessionSecurityTokenLifetimeInHours

Gets or sets the session security token lifetime.(Inherited from ClaimsSettingsBase.)

Methods

Name Description
System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_protmethod Finalize()

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_protmethod MemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethod ToString()

(Inherited from Object.)

Examples

ClaimsSettings claimsSettings = 
    (ClaimsSettings)deploymentService.Retrieve(DeploymentEntityType.ClaimsSettings, null);

//Disable Claims using SDK
claimsSettings.Enabled = false;
deploymentService.Update(claimsSettings);

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Microsoft.Xrm.Sdk.Deployment Namespace
Deployment entities and deployment configuration settings
Active Directory and claims-based authentication

Return to top

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright