Export (0) Print
Expand All
0 out of 1 rated this helpful - Rate this topic

Test-OAuthConnectivity

 

Applies to: Exchange Server 2013, Exchange Online

Topic Last Modified: 2014-01-08

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 | Sharepoint | Generic> -TargetUri <Uri> [-AppOnly <$true | $false>] [-Confirm [<SwitchParameter>]] [-Mailbox <MailboxIdParameter>] [-OrganizationDomain <String>] [-ReloadConfig <$true | $false>] [-UseCachedToken <$true | $false>] [-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:
Exchange 2013 creates the SharePoint 2013 and Lync 2013 partner applications in on-premises Exchange 2013 deployments. For Test-OAuthConnectivity cmdlet to succeed for other partner applications, you must have created the partner application first 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

  • SharePoint

  • Generic

TargetUri

Required

System.Uri

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

AppOnly

Optional

System.Boolean

The AppOnly parameter specifies the cmdlet will authenticate to the specified service as Exchange without any user context. Valid input for this parameter is $true or $false. The default value is $false.

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch.

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

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

ReloadConfig

Optional

System.Boolean

The ReloadConfig parameter reloads all the configuration settings from the Exchange configuration objects. Valid input for this parameter is $true or $false. The default value is $false. If you specify the value $false, the cached configuration settings are used.

UseCachedToken

Optional

System.Boolean

The UseCachedToken parameter specifies that OAuth will try to use an existing, cached authorization token. Valid input for this parameter is $true or $false. The default value is $false.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf 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.

 
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.