Edit

Share via

Get-EntraDomainFederationSettings

  • Reference
Module:
Microsoft.Graph.Entra

Retrieves settings for a federated domain.

Syntax

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.

Type:System.String
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

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

Type:System.String
Position:2
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

Outputs

Microsoft.Online.Administration.DomainFederationSettings

This cmdlet returns the following settings

ActiveLogOnUri

FederationBrandName

IssuerUri

LogOffUri

MetadataExchangeUri

NextSigningCertificate

PassiveLogOnUri

SigningCertificate