Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

Get-EntraDomainFederationSettings

Retrieves settings for a federated domain.

Syntax

Default (Default) 

Get-EntraDomainFederationSettings

 -DomainName <String>
 [-TenantId <String>]
 [<CommonParameters>]

Description

The Get-EntraDomainFederationSettings cmdlet gets key settings from Microsoft Entra ID.

Use the Get-EntraFederationProperty cmdlet to get settings for both Microsoft Entra ID and the Entra ID Federation Services server.

For delegated scenarios, the calling user must be assigned at least one of the following Microsoft Entra roles:

  • Global Reader
  • Security Reader
  • Domain Name Administrator
  • External Identity Provider Administrator
  • Hybrid Identity Administrator
  • Security Administrator

Examples

Example 1: Get federation settings for specified domain

Connect-Entra -Scopes 'Domain.Read.All'
Get-EntraDomainFederationSettings -DomainName 'contoso.com'

This command gets federation settings for specified domain.

  • -DomainName parameter specifies the fully qualified domain name to retrieve.

Parameters

-DomainName

The fully qualified domain name to retrieve.

Parameter properties

Type:System.String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-TenantId

The unique ID of the tenant to perform the operation on. If this isn't provided, then the value will default to the tenant of the current user. This parameter is only applicable to partner users.

Parameter properties

Type:System.String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Outputs

Microsoft.Online.Administration.DomainFederationSettings

This cmdlet returns the following settings

ActiveLogOnUri

FederationBrandName

IssuerUri

LogOffUri

MetadataExchangeUri

NextSigningCertificate

PassiveLogOnUri

SigningCertificate

Feedback

Was this page helpful?