Enable-AdfsClient
Enable-AdfsClient
Enables the use of an OAuth 2.0 client registration by AD FS.
Syntax
Parameter Set: Name
Enable-AdfsClient [[-TargetName] <String> ] [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: ClientId
Enable-AdfsClient [-TargetClientId] <String> [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: InputObject
Enable-AdfsClient [-TargetClient] <AdfsClient> [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Enable-AdfsClient enables the use of an OAuth 2.0 client registration by Active Directory Federation Services (AD FS). Use this cmdlet to enable a registered OAuth 2.0 client that is currently disabled. If AD FS receives a request for authorization from an OAuth 2.0 client that is registered with AD FS but not enabled, it will deny access to the resource.
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 enable.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-TargetClientId<String>
Specifies the client identifier for the registered OAuth 2.0 client to enable.
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 enable.
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: Enable an OAuth 2.0 client
This command enables the registered OAuth 2.0 client identified by the name Payroll Application.
PS C:\> Enable-AdfsClient -TargetName "Payroll Application"