Edit

Get-AdfsEndpoint

  • Reference
Module:
ADFS

Retrieves an endpoint in AD FS.

Syntax

Get-AdfsEndpoint
   [[-AddressPath] <String[]>]
   [<CommonParameters>]
Get-AdfsEndpoint
   [-FullUrl] <Uri[]>
   [<CommonParameters>]

Description

The Get-AdfsEndpoint cmdlet retrieves a specified endpoint from Active Directory Federation Services (AD FS). The collection of AdfsEndpoint objects is a list of all the supported endpoints that are on the server. You can use this list to view the configuration of endpoints and enable or disable them. To see the full list of endpoints, use this cmdlet with no parameters.

Examples

Example 1: Get an endpoint

PS C:\> Get-AdfsEndpoint -AddressPath "/adfs/services/trust/13/Windows"

This command gets the WS-Trust 1.3 endpoint.

Parameters

-AddressPath

Specifies an array of address paths that do not include the AD FS service name. The cmdlet gets endpoints that correspond to the paths that you specify. An example of such a path is /adfs/portal/updatepassword.

Type:String[]
Position:0
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-FullUrl

Specifies the full URL of the endpoint to retrieve.

Type:Uri[]
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Inputs

String[]

System.Uri[]

Outputs

Endpoint

AddressPath string ClientCredentialType string Enabled bool FullUrl uri Protocol string Proxy bool SecurityMode string Version string

Microsoft.IdentityServer.PowerShell.Resources.Endpoint

This cmdlet returns class structure that represents the endpoints for the Federation Service.

Notes

  • Endpoints provide access to the federation server functionality of AD FS, such as token issuance and the publication of federation metadata. Depending on the type of endpoint, you can enable or disable the endpoint or control whether the endpoint is published to Web Application Proxy.