federatedIdentityCredential 资源类型
命名空间:microsoft.graph
重要
Microsoft Graph /beta
版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。
引用应用程序的联合标识凭据。 从受信任的颁发者交换令牌以获取链接到Microsoft Entra ID上注册的应用程序的访问令牌时,这些联合标识凭据用于工作负载联合身份验证。
继承自 entity。
Methods
方法 | 返回类型 | Description |
---|---|---|
List | federatedIdentityCredential 集合 | 获取 federatedIdentityCredential 对象及其属性的列表。 |
创建 | federatedIdentityCredential | 创建新的 federatedIdentityCredential 对象。 |
Get | federatedIdentityCredential | 读取 federatedIdentityCredential 对象的属性和关系。 |
更新 | 无 | 更新 federatedIdentityCredential 对象的属性。 |
Upsert | federatedIdentityCredential | 如果不存在,请创建新的 federatedIdentityCredential ,或更新现有 federatedIdentityCredential 对象的属性。 |
删除 | None | 删除 federatedIdentityCredential 对象。 |
属性
属性 | 类型 | 说明 |
---|---|---|
观众 | 字符串集合 | 可在外部令牌中显示的受众。 此字段是必需的,对于Microsoft Entra ID,应设置为 api://AzureADTokenExchange 。 它说明了Microsoft 标识平台在传入令牌的aud 声明中应接受的内容。 此值表示外部标识提供者中的Microsoft Entra ID,并且跨标识提供者没有固定值 - 可能需要在标识提供者中创建新的应用程序注册,以充当此令牌的受众。 此字段只能接受单个值,限制为 600 个字符。 必填。 |
claimsMatchingExpression | federatedIdentityExpression | 可为 Null。 如果未设置, null 则默认为 。 允许对指定的声明使用与声明匹配的表达式。 如果定义了 claimsMatchingExpression , 则 subject 必须为 null 。 有关支持的表达式语法和声明的列表,请访问 灵活 FIC 参考。 |
description | String | 联合标识凭据的未经验证、用户提供的说明。 其限制为 600 个字符。 可选。 |
id | String | 联合标识的唯一标识符。 必填。 只读。 |
发行 | String | 外部标识提供者和 的 URL 必须与要交换的外部令牌的声明匹配 issuer 。
颁发者和使用者的值的组合在应用上必须是唯一的。 其限制为 600 个字符。 必填。 |
name | String | 联合标识凭据的唯一标识符,其限制为 120 个字符,并且必须对 URL 友好。 创建后,它是不可变的。 备用键。 必填。 不可为空。 支持 $filter (eq )。 |
subject | String | 可为 Null。 如果未设置, null 则默认为 。 外部标识提供者中外部软件工作负载的标识符。 与访问群体值一样,它没有固定的格式,因为每个标识提供者都使用自己的格式-有时是 GUID,有时是冒号分隔的标识符,有时是任意字符串。 此处的值必须与提供给 Microsoft Entra ID 的令牌中的声明匹配sub 。
颁发者和使用者的组合在应用上必须是唯一的。 其限制为 600 个字符。 如果定义了 subject , 则 claimsMatchingExpression 必须为 null 。 支持 $filter (eq )。 |
关系
无
JSON 表示形式
以下 JSON 表示形式显示了资源类型。
{
"@odata.type": "#microsoft.graph.federatedIdentityCredential",
"id": "String (identifier)",
"name": "String",
"issuer": "String",
"subject": "String",
"description": "String",
"audiences": [
"String"
],
"claimsMatchingExpression": {
"@odata.type": "microsoft.graph.federatedIdentityExpression"
}
}