Update federatedIdentityCredential

命名空间:microsoft.graph

更新 federatedIdentityCredential 对象的属性。

此 API 可用于以下国家级云部署

全局服务 美国政府 L4 美国政府 L5 (DOD) 由世纪互联运营的中国

权限

为此 API 选择标记为最低特权的权限。 只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考

权限类型 最低特权权限 更高特权权限
委派(工作或学校帐户) Application.ReadWrite.All 不可用。
委派(个人 Microsoft 帐户) Application.ReadWrite.All 不可用。
应用程序 Application.ReadWrite.OwnedBy Application.ReadWrite.All

HTTP 请求

可以使用其 IDappId 对应用程序进行寻址。 idappId 在 Microsoft Entra 管理中心 中的应用注册中分别称为“对象 ID”和“应用程序 (客户端) ID”。

还可以使用联合标识凭据的 ID 或名称对凭据进行寻

PATCH /applications/{id}/federatedIdentityCredentials/{federatedIdentityCredentialId}
PATCH /applications/{id}/federatedIdentityCredentials/{federatedIdentityCredentialName}
PATCH /applications(appId='{appId}')/federatedIdentityCredentials/{federatedIdentityCredentialId}
PATCH /applications(appId='{appId}')/federatedIdentityCredentials/{federatedIdentityCredentialName}

请求标头

名称 说明
Authorization 持有者 {token}。 必填。 详细了解 身份验证和授权
Content-Type application/json. 必需。

请求正文

在请求正文中,提供应更新的属性的值。 请求正文中未包含的现有属性会保留其以前的值,或者根据对其他属性值的更改重新计算。

下表指定可更新的属性。

属性 类型 说明
观众 字符串集合 可显示在已颁发令牌中的受众。 对于Microsoft Entra ID,将其值设置为 api://AzureADTokenExchange。 此字段只能接受单个值,限制为 600 个字符。
说明 String 用户提供的 federatedIdentityCredential 用途的说明。 其限制为 600 个字符。
发行 String 传入受信任颁发者的 URL (安全令牌服务) 。 匹配访问令牌的颁发者声明。 例如,在客户管理的密钥方案中,Microsoft Entra ID 是颁发者,有效值为 https://login.microsoftonline.com/{tenantid}/v2.0颁发者和使用者的值的组合在应用上必须是唯一的。 其限制为 600 个字符。
subject String
  • 对于Microsoft Entra颁发者,objectIdservicePrincipal (的 可以表示可以模拟应用的托管标识) 。 租户中需要存在与此 GUID 关联的对象。
  • 对于所有其他颁发者,没有其他验证的字符串

    颁发者和使用者的值的组合在应用上必须是唯一的。 其限制为 600 个字符。
  • 响应

    如果成功,此方法返回 204 No Content 响应代码。

    示例

    请求

    PATCH https://graph.microsoft.com/v1.0/applications/bcd7c908-1c4d-4d48-93ee-ff38349a75c8/federatedIdentityCredentials/15be77d1-1940-43fe-8aae-94a78e078da0
    Content-Type: application/json
    
    {
        "name": "testing02",
        "issuer": "https://login.microsoftonline.com/3d1e2be9-a10a-4a0c-8380-7ce190f98ed9/v2.0",
        "subject": "a7d388c3-5e3f-4959-ac7d-786b3383006a",
        "description": "Updated description",
        "audiences": [
            "api://AzureADTokenExchange"
        ]
    }
    

    响应

    HTTP/1.1 204 No Content