Set-AdfsClient
Set-AdfsClient
Modifies registration settings for an OAuth 2.0 client registered with AD FS.
Syntax
Parameter Set: Name
Set-AdfsClient [-TargetName] <String> [-ClientId <String> ] [-Description <String> ] [-Name <String> ] [-PassThru] [-RedirectUri <Uri[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: ClientId
Set-AdfsClient [-TargetClientId] <String> [-ClientId <String> ] [-Description <String> ] [-Name <String> ] [-PassThru] [-RedirectUri <Uri[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: InputObject
Set-AdfsClient [-TargetClient] <AdfsClient> [-ClientId <String> ] [-Description <String> ] [-Name <String> ] [-PassThru] [-RedirectUri <Uri[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed 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
-ClientId<String>
Specifies a string. The cmdlet modifies the OAuth 2.0 client registration information with the identifier that you specify.
Aliases |
none |
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
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.
Aliases |
none |
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.
The OAuth 2.0 client uses the redirection URI when the client requests authorization to access a resource secured by AD FS. You may register multiple redirection URIs for a single client identifier. The redirection URI must be a valid URI.
The redirection URI specified by the client must already be registered with AD FS and must correspond to the client identifier for that OAuth 2.0 client, in order for the client to be authorized to access the resource. If the client ID and redirection URI correspond to a pre-registered OAuth 2.0 client and the resource owner authorized access by providing their credentials, AD FS will deliver the authorization code or access token by redirecting the client's user-agent back to this redirection URI.
Ensure that the value of the RedirectUri parameter matches exactly the redirection URI that will be specified by the OAuth 2.0 client when requesting authorization, including trailing slashes (/), if required. Use more secure schemes, such as https, when you specify a redirection URI.
For Windows Store applications that authenticate using the Windows Web Authentication Broker, use the 'ms-app://' scheme when registering a redirect URI. For example, ms-app://s-1-15-2-1101140336-4090662585-1905587327-262951538-2732256205-1306401843-4235927180/ is a redirect URI for a Windows Store application. If you are developing a Windows Store application, you can obtain the redirect URI for your application using the following code fragment:
Uri redirectURI = Windows.Security.Authentication.Web.WebAuthenticationBroker.GetCurrentApplicationCallbackUri();
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-TargetClient<AdfsClient>
Specifies the registered OAuth 2.0 client to modify.
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 modify.
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 modify.
Aliases |
none |
Required? |
true |
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.
- System.Object
Examples
Example 1: Modify the redirection URI
This command changes the redirection URI for the OAuth 2.0 client currently registered with AD FS with the name Payroll Application.
PS C:\> Set-AdfsClient -TargetName "Payroll Application" -RedirectUri "https://localhost"
Example 2: Rename an OAuth 2.0 client
This command renames the OAuth 2.0 client currently registered with AD FS with the name Payroll Application.
PS C:\> Set-AdfsClient -TargetName "Payroll Application" -Name "Payroll Application v2"