Enable-AdfsClient

Enables the use of an OAuth 2.0 client registration by AD FS.

Syntax

Enable-AdfsClient
      [[-TargetName] <String>]
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Enable-AdfsClient
      [-TargetClientId] <String>
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Enable-AdfsClient
      [-TargetClient] <AdfsClient>
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Enable-AdfsClient cmdlet 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.

Examples

Example 1: Enable an OAuth 2.0 client

PS C:\> Enable-AdfsClient -TargetName "Payroll Application"

This command enables the registered OAuth 2.0 client identified by the name Payroll Application.

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 enable.

Type:AdfsClient
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-TargetClientId

Specifies the client identifier for the registered OAuth 2.0 client to enable.

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 enable.

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

AdfsClient objects are received by the TargetClient parameter.

String

String objects are received by the TargetClientId and TargetName parameters.

Outputs

AdfsClient

Returns the enabled AdfsClient object when the PassThru parameter is specified. By default, this cmdlet does not generate any output.