Add-AXSharepointClaimsAuthenticationProvider

Add-AXSharepointClaimsAuthenticationProvider

Adds a claims-based authentication provider to a Microsoft SharePoint Server installation. It also creates a web application associated with the provider where applicable.

Syntax

Parameter Set: Default
Add-AXSharepointClaimsAuthenticationProvider -Name <String> -SigningCertificate <X509Certificate2> -Type <String> [-ClearTextPassword <String> ] [-ConnectionString <String> ] [-Credential <PSCredential> ] [-Port <Int32> ] [-ServerUrl <String> ] [-SSLCertificate <X509Certificate2> ] [-UserName <String> ] [ <CommonParameters>]


Detailed description

The Add-AXSharepointClaimsAuthenticationProvider adds a claims-based authentication provider to a SharePoint Server installation and creates a web application associated with it when the type of authentication provider is Forms.

Parameters

-ClearTextPassword<String>

Sends the password of the business connector proxy account in clear text, rather than encrypted. UserName and ClearTextPassword are a way to specify the business connector proxy account. They cannot be used with the Credential parameter. UserName and ClearTextPassword are often used in scripts in which no user interaction is expected.

The SharePoint security token server (STS) web application created by this cmdlet uses this account as its IIS application pool identity.

Important: Using an account other than the business connector proxy account can result in errors when accessing Microsoft Dynamics AX through Enterprise Portal.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ConnectionString<String>

Specifies the string to use to connect to the ASP.NET SQLMembership database that is used for forms-based authentication.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Credential<PSCredential>

Specifies an account with administrator privileges on the SharePoint site. You must use the Business Connector proxy account. The Credential parameter cannot be used with the UserName and ClearTextPassword parameters.

The SharePoint security token server (STS) web application created by this cmdlet uses this account as its IIS application pool identity.

Important: Using an account other than the business connector proxy account can result in errors when accessing Microsoft Dynamics AX through Enterprise Portal.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Name<String>

Specifies the name to be associated with the authentication provider. When creating users in a forms-based authentication provider using New-AXUser, the value of this parameter is specified for the –UserDomain parameter.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Port<Int32>

Specifies the port on which the authentication provider SharePoint web application is created. The Port parameter is only valid for use with forms-based authentication—it cannot be specified if the provider is ADFS. If the specified port is already in use, the cmdlet returns an error.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-SSLCertificate<X509Certificate2>

Specifies the Secure Socket Layer (SSL) certificate to be associated with the SharePoint web application created for the authentication provider. SSL is required with forms-based authentication to help ensure the security of the credentials presented by the user to the forms-based authentication provider SharePoint web application. This parameter is not required for Type ADFS.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ServerUrl<String>

Specifies the Federation Service URL for the Active Directory Federation Service (ADFS) provider. This parameter is required when the Type is ADFS, and cannot be specified for other types of providers.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-SigningCertificate<X509Certificate2>

Specifies the self-signed certificate for use by the trusted identity provider. The provider uses the certificate to sign security tokens that it issues. The Enterprise Portal SharePoint web application uses this certificate to verify the authenticity of security tokens it receives.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Type<String>

Specifies the type of authentication provider to add. Provider types can be Forms or ADFS.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-UserName<String>

Specifies the username of the business connector proxy account. UserName and ClearTextPassword are a way to specify the business connector proxy account. They cannot be used with the Credential parameter. UserName and ClearTextPassword are often used in scripts in which no user interaction is expected.

The SharePoint security token server (STS) web application created by this cmdlet uses this account as its IIS application pool identity.

Important: Using an account other than the business connector proxy account can result in errors when accessing Microsoft Dynamics AX through Enterprise Portal.


Aliases

none

Required?

false

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, OutVariable, WarningAction, and WarningVariable. For more information, see about_CommonParameters http://go.microsoft.com/fwlink/?LinkID=113216

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • None


    You cannot pipe input to this cmdlet.


Outputs

The output type is the type of the objects that the cmdlet emits.

  • None


    The cmdlet does not generate any output.


Examples

Example 1: Add a forms-based authentication provider

This example adds a secure socket layers claims based authentication provider to a Microsoft SharePoint Server installation. The variables in the example were given values in previous statements.
$Cred = Get-Credential
$SigningCert = Get-PfxCertificate c:\certs\FORMS-CERT.cer
$SSLSTSCert = Get-PfxCertificate c:\certs\SSLCertForFBA.pfx



C:\PS>Add-AXSharepointClaimsAuthenticationProvider -Type Forms -Name FBAProvider -SigningCertificate $SigningCert -Credential $Cred -Port 7000 -SSLCertificate $SSLSTSCert

Example 2: Add an ADFS claims based authentication provider

This example adds an ADFS claims based authentication provider to a Microsoft SharePoint Server installation. The variables in the example were given values in previous statements.
$SigningCert = Get-PfxCertificate c:\certs\ADFS-CERT.cer



C:\PS>Add-AXSharepointClaimsAuthenticationProvider -Type ADFS -Name ADFSPROVIDER -SigningCertificate $SigningCert -ServerUrl "https://machinename.corp.contoso.com/adfs/ls/"



Copyright Microsoft Corporation. All rights reserved.
Show: