Disable-AdfsClient
Disable-AdfsClient
Disables an OAuth 2.0 client that is currently registered with AD FS.
Syntax
Parameter Set: Name
Disable-AdfsClient [[-TargetName] <String> ] [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: ClientId
Disable-AdfsClient [-TargetClientId] <String> [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: InputObject
Disable-AdfsClient [-TargetClient] <AdfsClient> [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Disable-AdfsClient cmdlet disables an OAuth 2.0 client that is currently registered with Active Directory Federation Services (AD FS). Once you disable the client, AD FS no longer authorizes requests to access resources from that OAuth 2.0 client.
Parameters
-PassThru
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-TargetClient<AdfsClient>
Specifies the registered OAuth 2.0 client to disable.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-TargetClientId<String>
Specifies the client identifier of the registered OAuth 2.0 client to disable.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-TargetName<String>
Specifies the name of the registered OAuth 2.0 client to disable.
Aliases |
none |
Required? |
false |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
Example 1: Disable an OAuth 2.0 client
This command disables the OAuth 2.0 client that is currently registered with AD FS.
PS C:\> Disable-AdfsClient -TargetName "Payroll Application"