Set-AuthConfig

 

Applies to: Exchange Server 2016

This cmdlet is available only in on-premises Exchange Server 2016.

Use the Set-AuthConfig cmdlet to modify the authorization configuration for your Exchange organization.

For information about the parameter sets in the Syntax section below, see Syntax.

Set-AuthConfig [-Realm <String>] [-ServiceName <String>] <COMMON PARAMETERS>
Set-AuthConfig -CertificateThumbprint <String> [-Force <SwitchParameter>] [-Server <ServerIdParameter>] [-SkipImmediateCertificateDeployment <SwitchParameter>] <COMMON PARAMETERS>
Set-AuthConfig [-Force <SwitchParameter>] [-NewCertificateEffectiveDate <DateTime>] [-NewCertificateThumbprint <String>] [-Server <ServerIdParameter>] [-SkipImmediateCertificateDeployment <SwitchParameter>] <COMMON PARAMETERS>
Set-AuthConfig [-ClearPreviousCertificate <SwitchParameter>] [-Force <SwitchParameter>] [-PublishCertificate <SwitchParameter>] <COMMON PARAMETERS>
COMMON PARAMETERS: [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-WhatIf [<SwitchParameter>]]

This example specifies a new certificate and a date when the certificate will become effective.

Set-AuthConfig -NewCertificateThumbprint DB821B4FCA2A5DA9593B9DE00C86BC5EA35D0FC0 -NewCertificateEffectiveDate 4/17/2013

This example immediately rolls over the certificate configured as the next certificate and makes it the current certificate. You must have installed a certificate marked as the next certificate.

Set-AuthConfig -PublishCertificate

The Set-AuthConfig parameter defines Microsoft Exchange as a partner application for server-to-server authentication with other partner applications such as Microsoft SharePoint 2013 and Microsoft Lync 2013 or Skype for Business Server 2015, including the certificate used for signing tokens. It's generally not required for this configuration to be modified except in some cases where you must use a different certificate instead of the self-signed certificate created by Exchange Setup or to use a new certificate after the old one has expired.

You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "Partner applications - configure" entry in the Sharing and collaboration permissions topic.

 

Parameter Required Type Description

CertificateThumbprint

Required

System.String

The CertificateThumbprint parameter specifies the thumbprint of the certificate to be used by Exchange for server-to-server authentication.

ClearPreviousCertificate

Optional

System.Management.Automation.SwitchParameter

The ClearPreviousCertificate switch clears the certificate saved as the previous certificate in the authorization configuration.

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.

  • Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false.

  • Most other cmdlets (for example, New-* and Set-* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.

Force

Optional

System.Management.Automation.SwitchParameter

The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch.

NewCertificateEffectiveDate

Optional

System.DateTime

The NewCertificateEffectiveDate parameter specifies a date when the certificate configured as the next certificate should be used.

NewCertificateThumbprint

Optional

System.String

The NewCertificateThumbprint parameter specifies the thumbprint of the new certificate to be used as the next certificate in the authorization configuration.

PublishCertificate

Optional

System.Management.Automation.SwitchParameter

The PublishCertificate switch specifies that the specified certificate be immediately rolled over as the current certificate. The certificate is immediately deployed to all Client Access servers.

Realm

Optional

System.String

The Realm parameter specifies a security realm for partner applications. If a service or user presents a token from a domain that's not an accepted domain in the Exchange organization, the token must contain the specified realm to gain access to resources.

Server

Optional

Microsoft.Exchange.Configuration.Tasks.ServerIdParameter

The Server parameter isn't available in this release.

ServiceName

Optional

System.String

The ServiceName parameter identifies Microsoft Exchange to other partner applications such as SharePoint 2013.

CautionCaution:
Exchange Setup configures the ServiceName parameter with a specific constant value. You shouldn't change this parameter. Changing the ServiceName parameter can result in server-to-server authentication with partner applications not functioning.

SkipImmediateCertificateDeployment

Optional

System.Management.Automation.SwitchParameter

The SkipImmediateCertificateDeployment switch specifies that the certificate shouldn't be used immediately. We recommend that you don't use this parameter in a production environment.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch.

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.

 
Show: