ClaimsSettings Class

Reference

Definition

Namespace:: Microsoft.Xrm.Sdk.Deployment

Assembly:: Microsoft.Xrm.Sdk.Deployment.dll

Package:: Microsoft.CrmSdk.Deployment v9.0.2.34

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public ref class ClaimsSettings : Microsoft::Xrm::Sdk::Deployment::ClaimsSettingsBase

[System.CodeDom.Compiler.GeneratedCode("System.Runtime.Serialization", "4.0.0.0")]
[System.Diagnostics.DebuggerStepThrough]
[System.Runtime.Serialization.DataContract(Name="ClaimsSettings", Namespace="http://schemas.microsoft.com/xrm/2011/Contracts/Deployment")]
public class ClaimsSettings : Microsoft.Xrm.Sdk.Deployment.ClaimsSettingsBase

[<System.CodeDom.Compiler.GeneratedCode("System.Runtime.Serialization", "4.0.0.0")>]
[<System.Diagnostics.DebuggerStepThrough>]
[<System.Runtime.Serialization.DataContract(Name="ClaimsSettings", Namespace="http://schemas.microsoft.com/xrm/2011/Contracts/Deployment")>]
type ClaimsSettings = class
    inherit ClaimsSettingsBase

Public Class ClaimsSettings
Inherits ClaimsSettingsBase

Inheritance: Object

DeploymentObject

DeploymentConfigSettings

ClaimsSettingsBase
ClaimsSettings

Attributes: GeneratedCodeAttribute DebuggerStepThroughAttribute DataContractAttribute

Examples

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

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

Constructors

ClaimsSettings()

Initializes a new instance of the ClaimsSettings class.

Properties

Enabled	Gets or sets whether the setting is enabled. (Inherited from ClaimsSettingsBase)
EncryptionCertificate	Gets or sets the encryption certificate. (Inherited from ClaimsSettingsBase)
ExtensionData	Gets or sets the structure that contains extra data. (Inherited from DeploymentObject)
FederationMetadataUrl	Gets or sets the federation metadata URL. (Inherited from ClaimsSettingsBase)
FederationProviderType	Gets or sets the federation provider type. (Inherited from ClaimsSettingsBase)
SessionSecurityTokenLifetimeInHours	Gets or sets the session security token lifetime. (Inherited from ClaimsSettingsBase)

Applies to