federatedIdentityCredential 资源类型

命名空间:microsoft.graph

重要

Microsoft Graph版本下的 /beta API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。

引用应用程序的联合标识凭据。 从受信任的颁发者交换令牌以获取链接到在 Azure AD 上注册的应用程序的访问令牌时,这些联合标识凭据用于 工作负荷标识联合

继承自 entity

注意: 此资源在 国家云 部署中不可用。

方法

方法 返回类型 说明
列出 federatedIdentityCredentials federatedIdentityCredential 集合 获取 federatedIdentityCredential 对象及其属性的列表。
Create federatedIdentityCredential federatedIdentityCredential 创建新的 federatedIdentityCredential 对象。
Get federatedIdentityCredential federatedIdentityCredential 读取 federatedIdentityCredential 对象的 属性和关系。
Update federatedIdentityCredential 更新 federatedIdentityCredential 对象的 属性。
Delete federatedIdentityCredential 删除 federatedIdentityCredential 对象。

属性

属性 类型 说明
观众 字符串集合 列出可以在外部令牌中显示的受众。 此字段是必需的,默认为“api://AzureADTokenExchange”。 它说明了Microsoft 标识平台应该接受aud传入令牌中的声明。 此值表示外部标识提供程序中的 Azure AD,并且在标识提供者之间没有固定值 - 可能需要在标识提供者中创建新的应用程序注册,以充当此令牌的受众。 必需。
description String 联合标识凭据的未经验证的用户提供的说明。 可选。
id String 联合标识的唯一标识符。 必需项。 只读。
发行 String 外部标识提供者的 URL,必须与要交换的外部令牌的声明匹配 issuer颁发者主题 的值的组合在应用中必须是唯一的。 必需项。
name 字符串 是联合标识凭据的唯一标识符,其字符限制为 120 个字符,必须对 URL 友好。 创建后,它是不可变的。 必填。 不可为空。 支持 $filtereq)。
subject String 必需。 外部标识提供程序中外部软件工作负荷的标识符。 与受众值一样,它没有固定格式,因为每个标识提供者都使用自己的标识提供者 - 有时是 GUID,有时是冒号分隔标识符,有时是任意字符串。 此处的 sub 值必须与显示给 Azure AD 的令牌内的声明匹配。 颁发者主题 的组合在应用中必须是唯一的。 支持 $filtereq)。

关系

JSON 表示形式

下面是资源的 JSON 表示形式。

{
  "@odata.type": "#microsoft.graph.federatedIdentityCredential",
  "name": "String",
  "issuer": "String",
  "subject": "String",
  "description": "String",
  "audiences": [
    "String"
  ]
}