Edit

Import-AdfsAuthenticationProviderConfigurationData

  • Reference
Module:
ADFS

Imports the custom configuration for an authentication provider.

Syntax

Import-AdfsAuthenticationProviderConfigurationData
      -Name <String>
      -FilePath <String>
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Import-AdfsAuthenticationProviderConfigurationData cmdlet imports custom configuration for an authentication provider from a file. Before you use this cmdlet, verify that the external authentication provider supports a custom configuration.

Use this cmdlet when the information specific to the authentication provider changes after you initially register the authentication provider. In some situations, the security key to access the authentication service can change and you must update the information in the Active Directory Federation Services (AD FS) configuration store for the authentication provider to function correctly.

Examples

Example 1: Import authentication provider configuration data

PS C:\> Import-AdfsAuthenticationProviderConfigurationData -Name "ContosoExternalAuthProvider" -FilePath "C:\share\test.txt"

This command imports the authentication provider configuration data. This command also overwrites existing configuration data for the specified authentication provider with the data from the file.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-FilePath

Specifies a file path. The cmdlet imports the configuration data from a file that you specify.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Name

Specifies the name of the authentication provider to import.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Outputs

Object