Set-AdfsClient

Set-AdfsClient

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

구문

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>]

자세한 설명

The Set-AdfsClient cmdlet modifies registration settings for an OAuth 2.0 client registered with AD FS(Active Directory Federation Services). 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.

매개 변수

-ClientId<String>

Specifies a string. The cmdlet modifies the OAuth 2.0 client registration information with the identifier that you specify.

-Description<String>

Specifies a description. The cmdlet modifies the OAuth 2.0 client registration information with the description that you specify.

-Name<String>

Specifies a name. The cmdlet modifies the OAuth 2.0 client registration information with the name that you specify.

-PassThru

작업하고 있는 항목을 나타내는 개체를 반환합니다. 기본적으로 이 cmdlet은 출력을 생성하지 않습니다.

-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();

-TargetClient<AdfsClient>

Specifies the registered OAuth 2.0 client to modify.

-TargetClientId<String>

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

-TargetName<String>

Specifies the name of the registered OAuth 2.0 client to modify.

-Confirm

cmdlet을 실행하기 전에 확인 메시지가 표시됩니다.

-WhatIf

cmdlet이 실행될 경우 결과 동작을 표시합니다. cmdlet이 실행되지 않습니다.

<CommonParameters>

이 cmdlet은 일반 매개 변수 -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer 및 -OutVariable을 지원합니다. 자세한 내용은 다음을 참조하세요. about_CommonParameters(https://go.microsoft.com/fwlink/p/?LinkID=113216).

입력

입력 유형은 cmdlet에 파이프할 수 있는 개체의 유형입니다.

출력

출력 유형은 cmdlet이 내보내는 개체의 유형입니다.

• System.Object

예제

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"

관련 항목

Add-AdfsClient

Disable-AdfsClient

Enable-AdfsClient

Get-AdfsClient

Remove-AdfsClient