Register-AdfsAuthenticationProvider
Register-AdfsAuthenticationProvider
Registers an external authentication provider in AD FS.
Syntax
Parameter Set: Default
Register-AdfsAuthenticationProvider -Name <String> -TypeName <String> [-ConfigurationFilePath <String> ] [ <CommonParameters>]
Detailed Description
The Register-AdfsAuthenticationProvider cmdlet registers an external authentication provider as a provider in Active Directory Federation Services (AD FS). Use the Get-AdfsAuthenticationProvider cmdlet to get a list of registered authentication providers.
Parameters
-ConfigurationFilePath<String>
Specifies the fully qualified file path of a file that contains authentication provider configuration data.
You can also upload the file to the Active Directory Federation Services (AD FS) configuration store and make it available to the authentication provider. Use this method if you want to provide additional information that pertains to a specific customer when you initialize the authentication provider. Any usage of this method is specific to the vendor that supplies the authentication provider.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Name<String>
Specifies the name of an authentication provider to register in AD FS.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-TypeName<String>
Specifies the fully qualified type of the authentication provider assembly on the federation server.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
- System.Object
Examples
Example 1: Register an authentication provider
The first command creates a variable named $TypeName that contains the configuration data for an external provider.
The second command registers the authentication provider by using the data stored in the $TypeName variable.
PS C:\> $TypeName = "ExternalAuthMethod.ExternalAuthProvider, ExternalAuthProvider, Version=1.0.0.0, Culture=neutral, PublicKeyToken=365143bb27e7ac8b, processorArchitecture=MSIL"
PS C:\> Register-AdfsAuthenticationProvider -TypeName $TypeName -Name "MyExternalAuthProvider" -ConfigurationFilePath ".\configdata.txt"