获取 samlOrWsFedExternalDomainFederation
本文内容
命名空间:microsoft.graph
读取特定 externalDomainName 的 samlOrWsFedExternalDomainFederation 对象的属性和关系。
此 API 可用于以下国家级云部署 。
全局服务
美国政府 L4
美国政府 L5 (DOD)
由世纪互联运营的中国
✅
✅
✅
✅
权限
为此 API 选择标记为最低特权的权限。 只有在应用需要它时 ,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型 。 要了解有关这些权限的详细信息,请参阅 权限参考 。
权限类型
最低特权权限
更高特权权限
委派(工作或学校帐户)
Domain.Read.All
Domain.ReadWrite.All
委派(个人 Microsoft 帐户)
不支持。
不支持。
应用程序
Domain.Read.All
Domain.ReadWrite.All
工作或学校帐户至少需要属于外部标识提供者管理员 Microsoft Entra角色 。
HTTP 请求
GET /directory/federationConfigurations/graph.samlOrWsFedExternalDomainFederation?$filter=domains/any(x: x/id eq 'domainName-value')
查询参数
此方法需要 $filter
OData 查询参数。 若要检索基于 externalDomainName 的特定 samlOrWsFedExternalDomainFederation 筛选器,请添加 ?$filter=domains/any(x: x/id eq 'domainName-value')
。
若要了解一般信息,请参阅 OData 查询参数 。
名称
说明
Authorization
持有者 {token}。 必填。 详细了解 身份验证和授权 。
请求正文
请勿提供此方法的请求正文。
响应
如果成功,此方法在 200 OK
响应正文中返回响应代码和 samlOrWsFedExternalDomainFederation 对象。
示例
请求
GET https://graph.microsoft.com/beta/directory/federationConfigurations/graph.samlOrWsFedExternalDomainFederation?$filter=domains/any(x: x/id eq 'contoso.com')
// Code snippets are only available for the latest version. Current version is 5.x
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Directory.FederationConfigurations["{identityProviderBase-id}"].GetAsync((requestConfiguration) =>
{
requestConfiguration.QueryParameters.Filter = "domains/any(x: x/id eq 'contoso.com')";
});
有关如何将 SDK 添加 到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档 。
// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc-beta directory federation-configurations get --identity-provider-base-id {identityProviderBase-id}
有关如何将 SDK 添加 到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档 。
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
graphdirectory "github.com/microsoftgraph/msgraph-beta-sdk-go/directory"
//other-imports
)
graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)
requestFilter := "domains/any(x: x/id eq 'contoso.com')"
requestParameters := &graphdirectory.DirectoryFederationConfigurationItemRequestBuilderGetQueryParameters{
Filter: &requestFilter,
}
configuration := &graphdirectory.DirectoryFederationConfigurationItemRequestBuilderGetRequestConfiguration{
QueryParameters: requestParameters,
}
federationConfigurations, err := graphClient.Directory().FederationConfigurations().ByIdentityProviderBaseId("identityProviderBase-id").Get(context.Background(), configuration)
有关如何将 SDK 添加 到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档 。
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
IdentityProviderBase result = graphClient.directory().federationConfigurations().byIdentityProviderBaseId("{identityProviderBase-id}").get(requestConfiguration -> {
requestConfiguration.queryParameters.filter = "domains/any(x: x/id eq 'contoso.com')";
});
有关如何将 SDK 添加 到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档 。
const options = {
authProvider,
};
const client = Client.init(options);
let samlOrWsFedExternalDomainFederation = await client.api('/directory/federationConfigurations/graph.samlOrWsFedExternalDomainFederation')
.version('beta')
.filter('domains/any(x: x/id eq \'contoso.com\')')
.get();
有关如何将 SDK 添加 到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档 。
<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Directory\FederationConfigurations\Item\IdentityProviderBaseItemRequestBuilderGetRequestConfiguration;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestConfiguration = new IdentityProviderBaseItemRequestBuilderGetRequestConfiguration();
$queryParameters = IdentityProviderBaseItemRequestBuilderGetRequestConfiguration::createQueryParameters();
$queryParameters->filter = "domains/any(x: x/id eq 'contoso.com')";
$requestConfiguration->queryParameters = $queryParameters;
$result = $graphServiceClient->directory()->federationConfigurations()->byIdentityProviderBaseId('identityProviderBase-id')->get($requestConfiguration)->wait();
有关如何将 SDK 添加 到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档 。
Import-Module Microsoft.Graph.Beta.Identity.DirectoryManagement
Get-MgBetaDirectoryFederationConfiguration -IdentityProviderBaseId $identityProviderBaseId -Filter "domains/any(x: x/id eq 'contoso.com')"
有关如何将 SDK 添加 到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档 。
from msgraph import GraphServiceClient
from msgraph.generated.directory.federationConfigurations.item.identity_provider_base_item_request_builder import IdentityProviderBaseItemRequestBuilder
graph_client = GraphServiceClient(credentials, scopes)
query_params = IdentityProviderBaseItemRequestBuilder.IdentityProviderBaseItemRequestBuilderGetQueryParameters(
filter = "domains/any(x: x/id eq 'contoso.com')",
)
request_configuration = IdentityProviderBaseItemRequestBuilder.IdentityProviderBaseItemRequestBuilderGetRequestConfiguration(
query_parameters = query_params,
)
result = await graph_client.directory.federation_configurations.by_identity_provider_base_id('identityProviderBase-id').get(request_configuration = request_configuration)
有关如何将 SDK 添加 到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档 。
响应
以下示例显示了相应的响应。
注意: 为了提高可读性,可能缩短了此处显示的响应对象。
HTTP/1.1 200 OK
Content-Type: application/json
{
"value": [
{
"id": "96db02e2-80c1-5555-bc3a-de92ffb8c5be",
"displayName": "Contoso",
"issuerUri": "http://contoso.com/adfs/services/trust",
"metadataExchangeUri": null,
"signingCertificate": "MIIC6DCCAdCgAwIBAgIQQ6vYJIVKQ",
"passiveSignInUri": "https://contoso.com/adfs/ls/",
"preferredAuthenticationProtocol": "saml",
"domains": [
{
"id": "contoso.com"
}
]
}
]
}