Configure claims settings (PowerShell)

Article
05/31/2016

Applies To: Dynamics CRM 2013

This sample code is Microsoft Dynamics CRM 2013. Download the Microsoft Dynamics CRM SDK package. It can be found in the following location in the download package:

SampleCode\PS1\ConfigureClaims.ps1

Requirements

To set up the Microsoft Dynamics CRM PowerShell cmdlets, see Administer the deployment using Windows PowerShell.

Demonstrates

The following script enables or disables claims authentication. You must specify the following parameters:

Enabled - A Boolean that specifies whether claims authentication is enabled or disabled.

EncryptionCertificate – An encryption certificate.

FederationMetadataUrl – A URL for federation metadata.

Example

param
(
    #optional params
    [boolean]$Enabled,
    [string]$EncryptionCertificate,
    [string]$FederationMetadataUrl
)

$RemoveSnapInWhenDone = $False

if (-not (Get-PSSnapin -Name Microsoft.Crm.PowerShell -ErrorAction SilentlyContinue))
{
    Add-PSSnapin Microsoft.Crm.PowerShell
    $RemoveSnapInWhenDone = $True
}

$ClaimsSettings = Get-CrmSetting -SettingType ClaimsSettings

if($PSBoundParameters.ContainsKey('Enabled')) {$ClaimsSettings.Enabled = $Enabled}
if($EncryptionCertificate) {$ClaimsSettings.EncryptionCertificate = $EncryptionCertificate}
if($FederationMetadataUrl) {$ClaimsSettings.FederationMetadataUrl = $FederationMetadataUrl}

Set-CrmSetting -Setting $ClaimsSettings

$ClaimsSettings

if($RemoveSnapInWhenDone)
{
    Remove-PSSnapin Microsoft.Crm.PowerShell
}

Configure claims settings (PowerShell)

Requirements

Demonstrates

Example

See Also

Additional resources