命名空间：microsoft.graph
重要
Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用，请使用 版本 选择器。
代理标识蓝图用作在 Microsoft Entra ID 生态系统中创建代理标识的模板。
继承自 应用程序。
此资源是一种开放类型，它允许除此处所述的属性之外的其他属性。
方法
属性
重要
虽然此资源继承自 应用程序，但某些属性不适用，返回 null 或默认值。 下表中排除了这些属性。
| 属性 | 类型 | 说明 |
|---|---|---|
| api | apiApplication | 指定实现 Web API 的代理标识蓝图的设置。 继承自 应用程序。 |
| appId | String | Microsoft Entra ID分配的代理标识蓝图的唯一标识符。 不可为 null。 只读。 继承自 应用程序。 |
| appRoles | appRole 集合 | 为代理标识蓝图定义的角色集合。 使用应用角色分配，可将这些角色分配给与其他应用程序关联的用户、组或服务主体。 不可为 null。 继承自 应用程序。 |
| 认证 | 认证 | 指定代理标识蓝图的认证状态。 继承自 应用程序。 |
| createdByAppId | 字符串 | 创建此代理标识蓝图的应用程序的唯一标识符。 通过Microsoft Entra ID在内部设置。 只读。 继承自 应用程序。 |
| createdDateTime | DateTimeOffset | 注册代理标识蓝图的日期和时间。 DateTimeOffset 表示使用 ISO 8601 格式的日期和时间信息，并且始终处于 UTC 时间。 只读。 继承自 应用程序。 |
| createdByAppId | 字符串 | 创建此代理标识蓝图的应用程序Microsoft Entra 管理中心) 上的 appId (名为 Application (客户端) ID。 通过Microsoft Entra ID在内部设置。 只读。 继承自 应用程序。 |
| description | String | 用于向最终用户提供代理标识蓝图说明的自由文本字段。 允许的最大大小为 1,024 个字符。 继承自 应用程序。 |
| disabledByMicrosoftStatus | String | 指定Microsoft是否已禁用已注册的代理标识蓝图。 可能的值为： null (默认值) NotDisabled， (DisabledDueToViolationOfServicesAgreement 原因可能包括可疑、滥用或恶意活动，或违反Microsoft服务协议) 。 继承自 应用程序。 |
| displayName | String | 代理标识蓝图的显示名称。 最大长度为 256 个字符。 继承自 应用程序。 |
| groupMembershipClaims | String |
groups配置代理标识蓝图所需的用户或 OAuth 2.0 访问令牌中颁发的声明。 若要设置此属性，请使用以下字符串值之一：None、 SecurityGroup (安全组和Microsoft Entra角色) ， All (这会获取登录用户是) 成员的所有安全组、通讯组和Microsoft Entra目录角色。 继承自 应用程序。 |
| id | String | 代理标识蓝图对象的唯一标识符。 此属性在Microsoft Entra 管理中心中称为“对象 ID”。 键。 不可为 null。 只读。 继承自 directoryObject。 |
| identifierUris | String collection | 此值也称为应用 ID URI，在将代理标识蓝图用作资源应用时设置。 identifierUris 充当在 API 代码中引用的范围的前缀，并且必须在Microsoft Entra ID中全局唯一。 不可为 null。 继承自 应用程序。 |
| info | informationalUrl | 代理标识蓝图的基本配置文件信息，例如市场营销、支持、服务条款和隐私声明 URL。 服务条款和隐私声明通过用户同意体验展示给用户。 继承自 应用程序。 |
| keyCredentials | keyCredential 集合 | 与代理标识蓝图关联的密钥凭据的集合。 不可为 null。 继承自 应用程序。 |
| optionalClaims | optionalClaims | 应用程序开发人员可以在其Microsoft Entra代理标识蓝图中配置可选声明，以指定Microsoft安全令牌服务发送到其应用程序的声明。 继承自 应用程序。 |
| passwordCredentials | passwordCredential 集合 | 与代理标识蓝图关联的密码凭据的集合。 不可为 null。 继承自 应用程序。 还可以在创建代理标识蓝图后通过调用“ 添加密码 API”来添加密码 。 |
| publisherDomain | String | 代理标识蓝图的已验证发布者域。 只读。 继承自 应用程序。 |
| serviceManagementReference | 字符串 | 引用服务或资产管理数据库中的应用程序或服务联系人信息。 可为 NULL。 继承自 应用程序。 |
| signInAudience | String | 指定当前代理标识蓝图支持的Microsoft帐户。 可能的值为： AzureADMyOrg (默认) 、 AzureADMultipleOrgsAzureADandPersonalMicrosoftAccount和 PersonalMicrosoftAccount。 继承自 应用程序。 |
| tags | 字符串集合 | 可用于对代理标识蓝图进行分类和标识的自定义字符串。 不可为 null。 继承自 应用程序。 |
| tokenEncryptionKeyId | Guid | 指定 keyCredentials 集合中的公共密钥的 keyId。 配置后，Microsoft Entra ID使用此属性指向的密钥加密它发出的所有令牌。 继承自 应用程序。 |
| 唯一名称 | String | 可分配给代理标识蓝图并用作备用密钥的唯一标识符。 不可变。 只读。 继承自 应用程序。 |
| verifiedPublisher | verifiedPublisher | 指定代理标识蓝图的已验证发布者。 继承自 应用程序。 |
| web | webApplication | 指定 Web 应用程序的设置。 继承自 应用程序。 |
关系
| 关系 | 类型 | 说明 |
|---|---|---|
| appManagementPolicies | appManagementPolicy 集合 | 应用于此代理标识蓝图的 appManagementPolicy。 继承自 microsoft.graph.application |
| federatedIdentityCredentials | federatedIdentityCredential 集合 | 代理标识蓝图的联合标识。 继承自 microsoft.graph.application |
| inheritablePermissions | inheritablePermission 集合 | 定义资源应用程序的范围，无需其他许可即可自动授予代理标识。 |
| owners | directoryObject collection | 作为此代理标识蓝图所有者的目录对象。 所有者是一组允许修改此对象的非管理员用户或服务主体。 只读。 可为 Null。 继承自 microsoft.graph.application |
| 赞助商 | directoryObject collection | 此代理标识蓝图的发起人。 发起者是可以授权和管理代理标识实例生命周期的用户或组。 在创建作期间是必需的。 |
JSON 表示形式
以下 JSON 表示形式显示了资源类型。 默认情况下，仅返回所有属性的子集。 只能使用 $select检索所有其他属性。
{
"@odata.type": "#microsoft.graph.agentIdentityBlueprint",
"id": "String (identifier)",
"appId": "String",
"identifierUris": ["String"],
"createdByAppId": "String",
"createdDateTime": "String (timestamp)",
"description": "String",
"disabledByMicrosoftStatus": "String",
"displayName": "String",
"groupMembershipClaims": "String",
"publisherDomain": "String",
"signInAudience": "String",
"tags": ["String"],
"tokenEncryptionKeyId": "Guid",
"uniqueName": "String",
"serviceManagementReference": "String",
"certification": {
"@odata.type": "microsoft.graph.certification"
},
"optionalClaims": {
"@odata.type": "microsoft.graph.optionalClaims"
},
"api": {
"@odata.type": "microsoft.graph.apiApplication"
},
"appRoles": [
{
"@odata.type": "microsoft.graph.appRole"
}
],
"info": {
"@odata.type": "microsoft.graph.informationalUrl"
},
"keyCredentials": [
{
"@odata.type": "microsoft.graph.keyCredential"
}
],
"passwordCredentials": [
{
"@odata.type": "microsoft.graph.passwordCredential"
}
],
"verifiedPublisher": {
"@odata.type": "microsoft.graph.verifiedPublisher"
},
"web": {
"@odata.type": "microsoft.graph.webApplication"
}
}