Applies to: Exchange Server 2013
Topic Last Modified: 2012-12-11
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.
Syntax
Test-OAuthConnectivity -Mailbox
<MailboxIdParameter> -Service <Exchange | Lync |
Sharepoint> [-Confirm [<SwitchParameter>]] [-TargetUri
<Uri>] [-WhatIf [<SwitchParameter>]]
|
Examples
EXAMPLE 1
This example tests OAuth connectivity with Exchange for Gurinder Singh.
 Copy Code |
|
|---|---|
Test-OAuthConnectivity -Mailbox "Gurinder Singh" -Service Exchange -TargetUri https://cas.contoso.com/ews/ |
|
Detailed Description
 Important: |
|---|
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.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Mailbox |
Required |
Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter |
The Mailbox parameter specifies the mailbox for which you want to test OAuth connectivity to a specified partner application. |
|
Service |
Required |
Microsoft.Exchange.Monitoring.ModServiceType |
The Service parameter specifies one of the following partner applications:
|
|
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. |
|
TargetUri |
Optional |
System.Uri |
The TargetUri parameter specifies the URL for the service you want to test OAuth connectivity with. |
|
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. |
Input Types
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.
Return Types
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.