Disable-AdfsClient
Disables an OAuth 2.0 client that is currently registered with AD FS.
Syntax
Disable-AdfsClient
[[-TargetName] <String>]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Disable-AdfsClient
[-TargetClientId] <String>
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Disable-AdfsClient
[-TargetClient] <AdfsClient>
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The Disable-AdfsClient cmdlet disables an OAuth 2.0 client that is currently registered with Active Directory Federation Services (AD FS). After you disable the client, AD FS no longer authorizes requests to access resources from that OAuth 2.0 client.
Examples
Example 1: Disable an OAuth 2.0 client
PS C:\> Disable-AdfsClient -TargetName "Payroll Application"This command disables the OAuth 2.0 client that is currently registered with AD FS.
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PassThru
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TargetClient
Specifies the registered OAuth 2.0 client to disable.
| Type: | AdfsClient |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-TargetClientId
Specifies the client identifier of the registered OAuth 2.0 client to disable.
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-TargetName
Specifies the name of the registered OAuth 2.0 client to disable.
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
AdfsClient objects are received by the TargetClient parameter.
String objects are received by the TargetClientId and TargetName parameters.
Outputs
Returns the disabled AdfsClient object when the PassThru parameter is specified. By default, this cmdlet does not generate any output.