更新 samlOrWsFedExternalDomainFederation
命名空间：microsoft.graph
更新 samlOrWsFedExternalDomainFederation 对象的属性。
此 API 可用于以下国家级云部署。
| 全局服务 | 美国政府 L4 | 美国政府 L5 (DOD) | 由世纪互联运营的中国 |
|---|---|---|---|
| ✅ | ✅ | ✅ | ✅ |
权限
为此 API 选择标记为最低特权的权限。 只有在应用需要它时，才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息，请参阅权限类型。 要了解有关这些权限的详细信息，请参阅 权限参考。
| 权限类型 | 最低特权权限 | 更高特权权限 |
|---|---|---|
| 委派（工作或学校帐户） | IdentityProvider.ReadWrite.All | 不可用。 |
| 委派（个人 Microsoft 帐户） | 不支持。 | 不支持。 |
| 应用程序 | IdentityProvider.ReadWrite.All | 不可用。 |
重要
在具有工作或学校帐户的委托方案中，必须为登录用户分配受支持的Microsoft Entra角色或具有支持的角色权限的自定义角色。 外部标识提供者管理员 是此操作支持的最低特权角色。
HTTP 请求
PATCH directory/federationConfigurations/graph.samlOrWsFedExternalDomainFederation/{samlOrWsFedExternalDomainFederation ID}
请求标头
| 名称 | 说明 |
|---|---|
| Authorization | 持有者 {token}。 必填。 详细了解 身份验证和授权。 |
| Content-Type | application/json. 必需。 |
请求正文
在请求正文中，为 JSON 对象提供一个或多个属性，这些属性需要为 Microsoft Entra租户中的 samlOrWsFedExternalDomainFederation 对象更新。
下表显示了可能为 samlOrWsFedExternalDomainFederation 对象更新的属性。
| 属性 | 类型 | 说明 |
|---|---|---|
| displayName | String | 基于 SAML/WS-Fed 的标识提供者的显示名称。 继承自 identityProviderBase。 |
| issuerUri | String | 联合服务器的颁发者 URI。 继承自 samlOrWsFedProvider。 |
| metadataExchangeUri | String | 用于从富客户端应用程序进行身份验证的元数据交换终结点的 URI。 继承自 samlOrWsFedProvider。 |
| passiveSignInUri | String | 登录Microsoft Entra服务时，基于 Web 的客户端定向到的 URI。 继承自 samlOrWsFedProvider。 |
| preferredAuthenticationProtocol | authenticationProtocol | 首选身份验证协议。 可能的值为： wsFed、 saml。 继承自 samlOrWsFedProvider。 |
| signingCertificate | String | 用于对传递到Microsoft 标识平台的令牌进行签名的当前证书。 证书的格式设置为联合 IdP 令牌签名证书的公共部分的 Base64 编码字符串，并且必须与 X509Certificate2 类兼容。 此属性在以下方案中使用：
Microsoft Entra ID通过自动注册过程更新证书，在该过程中，它尝试在当前证书到期前 30 天从联合身份验证服务元数据中检索新证书。 如果新证书不可用，Microsoft Entra ID每天监视元数据，并在新证书可用时更新域的联合设置。 |
响应
如果成功，此方法在响应正文中返回响应 200 OK 代码和更新的 samlOrWsFedExternalDomainFederation 对象。
示例
请求
PATCH https://graph.microsoft.com/beta/directory/federationConfigurations/graph.samlOrWsFedExternalDomainFederation/d5a56845-6845-d5a5-4568-a5d54568a5d5
Content-Type: application/json
{
"displayName": "Contoso name change",
"issuerUri": "http://contoso-test.com/adfs/services/trust",
"metadataExchangeUri": null,
"signingCertificate": "M66C6DCCAdCgAwIBAgIQQ6vYJIVKQ",
"passiveSignInUri": "https://contoso-test.com/adfs/ls/",
"preferredAuthenticationProtocol": "wsFed"
}
响应
以下示例显示了相应的响应。
注意：为了提高可读性，可能缩短了此处显示的响应对象。
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "d5a56845-6845-d5a5-4568-a5d54568a5d5",
"displayName": "Contoso name change",
"issuerUri": "http://contoso-test.com/adfs/services/trust",
"metadataExchangeUri": null,
"signingCertificate": "M66C6DCCAdCgAwIBAgIQQ6vYJIVKQ",
"passiveSignInUri": "https://contoso-test.com/adfs/ls/",
"preferredAuthenticationProtocol": "wsFed",
"domains": [
{
"id": "contoso.com"
}
]
}