samlOrWsFedExternalDomainFederation リソースの種類

名前空間: microsoft.graph

重要

Microsoft Graph のバージョンの /beta API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 API が v1.0 で使用できるかどうかを確認するには、 バージョン セレクターを使用します。

Azure Active Directory (Azure AD) テナントが、ID プロバイダー (IdP) が SAML または WS-Fed プロトコルのいずれかをサポートする別の組織とのフェデレーションを設定できるリソース。 これにより、Azure ADテナントは、ゲスト ユーザーがリソースにアクセスできます。 SAML/WS-Fed IdP フェデレーションの詳細については、「ゲスト ユーザー向け SAML/WS-FedID プロバイダーとのフェデレーション」を参照してください。

samlOrWsFedProvider から継承します

メソッド

メソッド 戻り値の種類 説明
samlOrWsFedExternalDomainFederations の一覧 samlOrWsFedExternalDomainFederation コレクション samlOrWsFedExternalDomainFederationオブジェクトとそのプロパティの一覧を取得します。
samlOrWsFedExternalDomainFederation の作成 samlOrWsFedExternalDomainFederation 新しい samlOrWsFedExternalDomainFederation オブジェクトを作成 します。
samlOrWsFedExternalDomainFederation を取得する samlOrWsFedExternalDomainFederation samlOrWsFedExternalDomainFederationオブジェクトのプロパティとリレーションシップを読み取る。
samlOrWsFedExternalDomainFederation の更新 samlOrWsFedExternalDomainFederation samlOrWsFedExternalDomainFederation オブジェクトのプロパティを更新します。
samlOrWsFedExternalDomainFederation の削除 なし samlOrWsFedExternalDomainFederation オブジェクトを削除します。
ドメインを一覧表示する externalDomainName コレクション domains ナビゲーション プロパティから externalDomainName リソースを取得します。
externalDomainName の作成 externalDomainName 新しい externalDomainName オブジェクトを作成します。

プロパティ

プロパティ 種類 説明
displayName String SAML またはベース IdP のWS-Fed名です。 identityProviderBase から継承されます。
id 文字列 ID プロバイダーの識別子。 エンティティから継承 されます
issuerUri String フェデレーション サーバーの発行者 URI。 samlOrWsFedProvider から継承されます
metadataExchangeUri String リッチ クライアント アプリケーションからの認証に使用されるメタデータ交換エンドポイントの URI。 samlOrWsFedProvider から継承されます
passiveSignInUri String Web ベースのクライアントが Azure ADサービスにサインインするときに指示される URI。 samlOrWsFedProvider から継承されます
preferredAuthenticationProtocol String 優先認証プロトコル。 サポートされている値には、 または saml が含まれます wsfedsamlOrWsFedProvider から継承されます
signingCertificate String 証明書に渡されたトークンに署名するために使用Microsoft ID プラットフォーム。 証明書は、フェデレーション IdP のトークン署名証明書のパブリック部分の Base64 エンコード文字列として書式設定され、X509Certificate2 クラスと互換性がある必要があります。

このプロパティは、次のシナリオで使用されます。
  • 自動ロールオーバー更新プログラムの外部でロールオーバーが必要な場合
  • 新しいフェデレーション サービスのセットアップ中
  • フェデレーション サービス証明書が更新された後、新しいトークン署名証明書がフェデレーション プロパティに存在しない場合。


Azure ADは、現在の証明書の有効期限の 30 日前に、フェデレーション サービス メタデータから新しい証明書を取得しようとする自動ロールオーバー プロセスを介して証明書を更新します。 新しい証明書が使用できない場合、Azure ADはメタデータを毎日監視し、新しい証明書が利用可能なときにドメインのフェデレーション設定を更新します。

samlOrWsFedProvider から継承されます

リレーションシップ

リレーションシップ 説明
ドメイン externalDomainName コレクション テナントがフェデレーションしている外部組織のドメイン名のコレクション。 $filter (eq)をサポートしています。

JSON 表記

リソースの JSON 表記を次に示します。

{
  "@odata.type": "#microsoft.graph.samlOrWsFedExternalDomainFederation",
  "id": "String (identifier)",
  "displayName": "String",
  "issuerUri": "String",
  "metadataExchangeUri": "String",
  "signingCertificate": "String",
  "passiveSignInUri": "String",
  "preferredAuthenticationProtocol": "String"
}