Any suggestions? Export (0) Print
Expand All

Test-OAuthConnectivity

 

Applies to: Exchange Online, Exchange Server 2016

This cmdlet is available in on-premises Exchange Server 2016 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Test-OAuthConnectivity cmdlet to test OAuth authentication to partner applications for a user.

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

Test-OAuthConnectivity -Service <EWS | AutoD | Generic> -TargetUri <Uri> [-AppOnly <SwitchParameter>] [-Confirm [<SwitchParameter>]] [-Mailbox <MailboxIdParameter>] [-OrganizationDomain <String>] [-ReloadConfig <SwitchParameter>] [-UseCachedToken <SwitchParameter>] [-WhatIf [<SwitchParameter>]]

This example tests OAuth connectivity with Exchange for Gurinder Singh.

Test-OAuthConnectivity -Service EWS -TargetUri https://cas.contoso.com/ews/ -Mailbox "Gurinder Singh"

importantImportant:
SharePoint, Lync, and Skype for Business partner applications are automatically created in on-premises Exchange deployments. For the Test-OAuthConnectivity cmdlet to succeed for other partner applications, you first need to create the partner application by using the Configure-EnterpriseApplication.ps1 script.

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

Service

Required

Microsoft.Exchange.Monitoring.ModServiceType

The Service parameter specifies the partner application. Valid values for this parameter are:

  • EWS

  • AutoD

  • Generic

TargetUri

Required

System.Uri

The TargetUri parameter specifies the URL for the service you want to test OAuth connectivity with.

AppOnly

Optional

System.Management.Automation.SwitchParameter

The AppOnly switch specifies the cmdlet will authenticate to the specified service as Exchange without any user context. You don't need to specify a value with this switch.

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.

Mailbox

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter

The Mailbox parameter specifies the mailbox for which you want to test OAuth connectivity to the specified partner application.

OrganizationDomain

Optional

System.String

This parameter is available only in the cloud-based service.

The OrganizationDomain parameter specifies the domain name of the Office 365 organization. For example, contoso.com.

ReloadConfig

Optional

System.Management.Automation.SwitchParameter

The ReloadConfig switch reloads all the configuration settings from the Exchange configuration objects. You don't need to specify a value with this switch. If you don't use this switch, the cached configuration settings are used.

UseCachedToken

Optional

System.Management.Automation.SwitchParameter

The UseCachedToken switch specifies that OAuth will try to use an existing, cached authorization token. You don't need to specify a value with this switch.

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:
© 2016 Microsoft