Set-AdfsClient

Set-AdfsClient is accessible with the help of adfs module. To install adfs on your system please refer to this adfs.

Synopsis

Modifies registration settings for an OAuth 2.0 client registered with AD FS.

Description

The Set-AdfsClient cmdlet modifies registration settings for an OAuth 2.0 client registered with Active Directory Federation Services (AD FS). Use this cmdlet to modify the settings, including the client identifier, redirection URI, name, or description of the OAuth 2.0 client. You can also use this cmdlet to register additional redirection URIs for the OAuth 2.0 client.

Parameters

-ADUserPrincipalName
Specifies an Active Directory user principal name.

    Required?                    false
    Position?                    named
    Default value                none
    Accept pipeline input?       false
    Accept wildcard characters?  false

-ChangeClientSecret <SwitchParameter>


    Required?                    false
    Position?                    named
    Default value                none
    Accept pipeline input?       false
    Accept wildcard characters?  false

-ClientId <String>
    Specifies a string. The cmdlet modifies the OAuth 2.0 client registration information with the identifier that you specify.

    Required?                    false
    Position?                    named
    Default value                none
    Accept pipeline input?       True (ByPropertyName)
    Accept wildcard characters?  false

-Description <String>
    Specifies a description. The cmdlet modifies the OAuth 2.0 client registration information with the description that you specify.

    Required?                    false
    Position?                    named
    Default value                none
    Accept pipeline input?       True (ByPropertyName)
    Accept wildcard characters?  false

-Force <SwitchParameter>
    Forces the command to run without asking for user confirmation.

    Required?                    false
    Position?                    named
    Default value                none
    Accept pipeline input?       false
    Accept wildcard characters?  false

-JWKSFile <String>


    Required?                    false
    Position?                    named
    Default value                none
    Accept pipeline input?       false
    Accept wildcard characters?  false

-JWKSUri <Uri>


    Required?                    false
    Position?                    named
    Default value                none
    Accept pipeline input?       false
    Accept wildcard characters?  false

-JWTSigningCertificate <X509Certificate2[]>


    Required?                    false
    Position?                    named
    Default value                none
    Accept pipeline input?       false
    Accept wildcard characters?  false

-JWTSigningCertificateRevocationCheck <Microsoft.IdentityServer.PolicyModel.Configuration.RevocationSetting>
    The acceptable values for this parameter are:

    -- None
    -- CheckEndCert
    -- CheckEndCertCacheOnly
    -- CheckChain
    -- CheckChainCacheOnly
    -- CheckChainExcludeRoot
    -- CheckChainExcludeRootCacheOnly

    Required?                    false
    Position?                    named
    Default value                none
    Accept pipeline input?       false
    Accept wildcard characters?  false

-Name <String>
    Specifies a name. The cmdlet modifies the OAuth 2.0 client registration information with the name that you specify.

    Required?                    false
    Position?                    named
    Default value                none
    Accept pipeline input?       True (ByPropertyName)
    Accept wildcard characters?  false

-PassThru <SwitchParameter>
    Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

    Required?                    false
    Position?                    named
    Default value                none
    Accept pipeline input?       false
    Accept wildcard characters?  false

-RedirectUri <Uri[]>
    Specifies one or more redirection URIs. The cmdlet modifies the OAuth 2.0 client registration information with the redirection URIs that you specify.


    Required?                    false
    Position?                    named
    Default value                none
    Accept pipeline input?       True (ByPropertyName)
    Accept wildcard characters?  false

-ReloadJWTSigningKeys <SwitchParameter>


    Required?                    false
    Position?                    named
    Default value                none
    Accept pipeline input?       false
    Accept wildcard characters?  false

-ResetClientSecret <SwitchParameter>


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

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

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

    Required?                    true
    Position?                    1
    Default value                none
    Accept pipeline input?       True (ByPropertyName)
    Accept wildcard characters?  false

-Confirm <SwitchParameter>
    Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.

    Required?                    false
    Position?                    named
    Default value                false
    Accept pipeline input?       false
    Accept wildcard characters?  false

-WhatIf <SwitchParameter>
    Shows what would happen if the cmdlet runs. The cmdlet is not run.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

Syntax

Set-AdfsClient [-TargetName] <String> [-ClientId <String>] [-Name <String>] [-RedirectUri <Uri[]>] [-Description <String>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]

Set-AdfsClient [-TargetClientId] <String> [-ClientId <String>] [-Name <String>] [-RedirectUri <Uri[]>] [-Description <String>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]

Set-AdfsClient [-TargetClient] <AdfsClient> [-ClientId <String>] [-Name <String>] [-RedirectUri <Uri[]>] [-Description <String>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]

——————Example 1——————
Modify the redirection URI
PS C:> Set-AdfsClient -TargetName “Payroll Application” -RedirectUri “https://localhost”
This command changes the redirection URI for the OAuth 2.0 client currently registered with AD FS with the name Payroll Application.

——————Example 1——————
Rename an OAuth 2.0 client
PS C:> Set-AdfsClient -TargetName “Payroll Application” -Name “Payroll Application v2”
This command renames the OAuth 2.0 client currently registered with AD FS with the name Payroll Application.

You can check the Version, CommandType and Source of this cmdlet by giving below command.

Get-Command Set-AdfsClient

You can also read about

To know more PowerShell cmdlets(Commands) on Active Directory Federation Services(ADFS) click here

Click on this Link for an Single place where you get all the PowerShell cmdlet sorted based on the modules.

You can also refer other blogs on PowerShell at link

You can also refer other blogs on Microsoft at link

And also if you required any technology you want to learn, let us know below we will publish them in our site http://tossolution.com/

Like our page in Facebook and follow us for New technical information.

References are taken from Microsoft