Disable-AdfsClient
Disables an OAuth 2.0 client that is currently registered with AD FS.
Syntax
Name (Default)
Disable-AdfsClient
[[-TargetName] <String>]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ClientId
Disable-AdfsClient
[-TargetClientId] <String>
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
InputObject
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.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-PassThru
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-TargetClient
Specifies the registered OAuth 2.0 client to disable.
Parameter properties
| Type: | AdfsClient |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
InputObject
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-TargetClientId
Specifies the client identifier of the registered OAuth 2.0 client to disable.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ClientId
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-TargetName
Specifies the name of the registered OAuth 2.0 client to disable.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Name
| Position: | 0 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
AdfsClient
AdfsClient objects are received by the TargetClient parameter.
String
String objects are received by the TargetClientId and TargetName parameters.
Outputs
AdfsClient
Returns the disabled AdfsClient object when the PassThru parameter is specified. By default, this cmdlet does not generate any output.