Commands › Exchange Online

Set-AuthConfig

Exchange Online ExchangeOnlineManagement Set-*

Modify the authorization configuration for your Exchange organization.

Quick start script

# Set-AuthConfig — quick start (serv365.ai)
# 1. Connect (app-only shown; interactive: omit the certificate parameters)
Connect-ExchangeOnline -CertificateThumbprint $thumb -AppId $appId -Organization $org

# 2. Capture the current state first — you cannot roll back what you never recorded
$before = Get-AuthConfig
$before | Format-List

# 3. Make the change (dry run first)
Set-AuthConfig -CertificateThumbprint <String> -WhatIf
Set-AuthConfig -CertificateThumbprint <String>

# 4. Verify and diff
$after = Get-AuthConfig
Compare-Object ($before | Out-String) ($after | Out-String)

Syntax — 4 parameter sets

CurrentCertificateParameter

Set-AuthConfig -CertificateThumbprint <String>
 [-SkipImmediateCertificateDeployment]
 [-Confirm]
 [-DomainController <Fqdn>]
 [-Force]
 [-Server <ServerIdParameter>]
 [-WhatIf]
 [<CommonParameters>]

PublishAuthCertificateParameter

Set-AuthConfig [-ClearPreviousCertificate]
 [-PublishCertificate]
 [-Confirm]
 [-DomainController <Fqdn>]
 [-Force]
 [-WhatIf]
 [<CommonParameters>]

NewCertificateParameter

Set-AuthConfig [-NewCertificateEffectiveDate <DateTime>]
 [-NewCertificateThumbprint <String>]
 [-SkipImmediateCertificateDeployment]
 [-Confirm]
 [-DomainController <Fqdn>]
 [-Force]
 [-Server <ServerIdParameter>]
 [-WhatIf]
 [<CommonParameters>]

AuthConfigSettings

Set-AuthConfig [-Realm <String>]
 [-ServiceName <String>]
 [-Confirm]
 [-DomainController <Fqdn>]
 [-WhatIf]
 [<CommonParameters>]

Parameters (13)

ParameterTypeRequiredWhat it controls
-CertificateThumbprint String yes The CertificateThumbprint parameter specifies the thumbprint of the certificate to be used by Exchange for server-to-server authentication.
-ClearPreviousCertificate SwitchParameter The ClearPreviousCertificate switch clears the certificate that was saved as the previous certificate in the authorization configuration. You don't need to specify a value with this switch.
-Confirm SwitchParameter The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on whether the cmdlet requires confirmation before proceeding.
-DomainController 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...
-Force SwitchParameter The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch.
-NewCertificateEffectiveDate DateTime The NewCertificateEffectiveDate parameter specifies a date when the certificate configured as the next certificate should be used.
-NewCertificateThumbprint String The NewCertificateThumbprint parameter specifies the thumbprint of the new certificate to be used as the next certificate in the authorization configuration.
-PublishCertificate SwitchParameter The PublishCertificate switch immediately rolls over the specified certificate as the current certificate. You don't need to specify a value with this switch.
-Realm 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...
-Server ServerIdParameter The Server parameter isn't available in this release.
-ServiceName String The ServiceName parameter identifies Microsoft Exchange to other partner applications such as SharePoint 2013.
-SkipImmediateCertificateDeployment SwitchParameter The SkipImmediateCertificateDeployment switch specifies that the certificate shouldn't be used immediately. You don't need to specify a value with this switch.
-WhatIf SwitchParameter The WhatIf switch shows what the command does without making any changes. You don't need to specify a value with this switch.

Reference facts derived from Microsoft documentation, © Microsoft, licensed CC BY 4.0; restructured with original guidance by serv365.ai.