samlOrWsFedExternalDomainFederation リソースの種類
名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
Microsoft Entra テナントが、ID プロバイダー (IdP) が SAML または WS-Fed プロトコルをサポートする別の組織とのフェデレーションを設定できるようにするリソース。 これにより、Microsoft Entra テナントはゲスト ユーザーがリソースにアクセスできるようになります。 SAML/WS-Fed IdP フェデレーションの詳細については、「 ゲスト ユーザー向けの SAML/WS-Fed ID プロバイダーとのフェデレーション」を参照してください。
samlOrWsFedProvider から継承します。
メソッド
| メソッド | 戻り値の種類 | 説明 |
|---|---|---|
| List | samlOrWsFedExternalDomainFederation コレクション | samlOrWsFedExternalDomainFederation オブジェクトとそのプロパティの一覧を取得します。 |
| Create | samlOrWsFedExternalDomainFederation | 新しい samlOrWsFedExternalDomainFederation オブジェクトを 作成します。 |
| Get | samlOrWsFedExternalDomainFederation | samlOrWsFedExternalDomainFederation オブジェクトのプロパティとリレーションシップを読み取ります。 |
| Update | samlOrWsFedExternalDomainFederation | samlOrWsFedExternalDomainFederation オブジェクトのプロパティを更新します。 |
| Delete | なし | samlOrWsFedExternalDomainFederation オブジェクトを削除します。 |
| ドメインを一覧表示する | externalDomainName コレクション | domains ナビゲーション プロパティから externalDomainName リソースを取得します。 |
| 外部ドメイン名を作成する | externalDomainName | 新しい externalDomainName オブジェクトを作成します。 |
プロパティ
| プロパティ | 型 | 説明 |
|---|---|---|
| displayName | String | SAML または WS-Fed ベースの IdP の表示名。 identityProviderBase から継承されます。 |
| id | 文字列 | ID プロバイダーの識別子。 エンティティから継承 されます。 |
| issuerUri | String | フェデレーション サーバーの発行者 URI。 samlOrWsFedProvider から継承されます。 |
| metadataExchangeUri | String | リッチ クライアント アプリケーションからの認証に使用されるメタデータ交換エンドポイントの URI。 samlOrWsFedProvider から継承されます。 |
| passiveSignInUri | String | Microsoft Entra サービスにサインインするときに Web ベースのクライアントが転送する URI。 samlOrWsFedProvider から継承されます。 |
| preferredAuthenticationProtocol | String | 優先認証プロトコル。 サポートされる値には、 saml または wsfedが含まれます。
samlOrWsFedProvider から継承されます。 |
| signingCertificate | String | Microsoft ID プラットフォームに渡されるトークンの署名に使用される現在の証明書。 証明書は、フェデレーション IdP のトークン署名証明書のパブリック部分の Base64 でエンコードされた文字列として書式設定され、X509Certificate2 クラスと互換性がある必要があります。 このプロパティは、次のシナリオで使用されます。
Microsoft Entra ID は、現在の証明書の有効期限が切れる 30 日前に、フェデレーション サービスメタデータから新しい証明書を取得しようとする自動登録プロセスを介して証明書を更新します。 新しい証明書が使用できない場合、Microsoft Entra ID はメタデータを毎日監視し、新しい証明書が使用可能になるとドメインのフェデレーション設定を更新します。 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"
}