servicePrincipal 资源类型
命名空间：microsoft.graph
重要
Microsoft Graph版本下的 /beta API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用，请使用 版本 选择器。
表示目录中的一个应用程序实例。 继承自 directoryObject。
该资源支持通过提供 delta 函数使用增量查询跟踪增量添加、删除和更新。 此资源是允许传入其他属性的开放类型。
Methods
属性
重要
仅当使用设置为 eventual 和 $count 的 ConsistencyLevel 标头时，才支持 $filter 和 $search 查询参数的特定用法。 有关详细信息，请参阅 Azure AD 目录对象的高级查询功能。
| 属性 | 类型 | 说明 |
|---|---|---|
| accountEnabled | Boolean | 如果启用了服务主体帐户，则true;否则，false。支持$filter（eq、ne、not、in）。 |
| addIns | addIn 集合 | 定义使用服务可用于调用特定上下文中的应用的自定义行为。 例如，呈现文件流的应用程序可能会为其“FileHandler”功能设置 addIns 属性。 这将使 Microsoft 365 之类的服务在用户正在处理的文档上下文中调用应用程序。 |
| alternativeNames | 字符串集合 | 用于按订阅检索服务主体，标识的托管标识的资源组和完整资源 ID。支持$filter（eq、not、ge、le、startsWith）。 |
| 应用说明 | String | 相关应用程序公开的说明。 |
| appDisplayName | String | 关联应用程序公开的显示名称。 |
| appId | String | 关联应用程序的唯一标识符（其 appId 属性）。支持 $filter （eq、 ne、 not、 in、 startsWith）。 |
| applicationTemplateId | String | 从中创建 servicePrincipal 的 applicationTemplate 的唯一标识符。只读。支持 $filter （eq、 ne、 NOT、 startsWith）。 |
| appOwnerOrganizationId | Guid | 包含注册应用程序的租户 ID。 这仅适用于应用程序支持的服务主体。支持 $filter（eq、ne、NOT、ge、le）。 |
| appRoleAssignmentRequired | Boolean | 指定是否需要向用户或其他服务主体授予此服务主体的应用角色分配，然后用户才能登录或应用可以获取令牌。默认值为 false。不可为 null。 支持 $filter（eq、ne、NOT）。 |
| appRoles | appRole 集合 | 该服务主体代表的应用程序公开的角色。 有关详细信息，请参阅 应用程序实体上的 appRoles 属性定义。 不可为空。 |
| customSecurityAttributes | customSecurityAttributeValue | 保留分配给目录对象的自定义安全属性的值的开放式复杂类型。可为空。 仅在 $select 上返回。 支持 $filter （eq、 ne、 not、 startsWith）。 |
| deletedDateTime | DateTimeOffset | 删除服务主体的日期和时间。只读。 |
| 说明 | 字符串 | 免费文本字段，提供面向内部最终用户的服务主体说明。 "MyApps " 等最终用户门户将在此字段中显示应用程序说明。 最大允许大小为 1024 个字符。 支持 $filter（eq、ne、not、ge、le、startsWith）和 $search。 |
| disabledByMicrosoftStatus | String | 指定 Microsoft 是否已禁用已注册的应用程序。可能的值为：null（默认值）、NotDisabled 和 DisabledDueToViolationOfServicesAgreement（原因可能包括可疑、滥用或恶意活动或违反 Microsoft 服务协议）。 支持 $filter（eq、ne、not）。 |
| displayName | String | 服务主体的显示名称。 支持 $filter（eq、ne、not、ge、le、in、startsWith 和 null 值上的 eq）、$search 和 $orderBy。 |
| errorUrl | String | 已弃用。 请勿使用。 |
| homepage | String | 应用程序的主页或登录页面。 |
| id | String | 服务主体的唯一标识符。继承自 directoryObject。关键。不可为 null。只读。支持 $filter （eq、 ne、 not、 in）。 |
| info | informationalUrl | 所获取应用程序的基本配置文件信息，如应用的市场营销、支持、服务条款和隐私声明 URL。 服务条款和隐私声明通过用户同意体验展示给用户。 有关详细信息，请参阅如何：为已注册的 Azure AD 应用添加服务条款和隐私声明。 支持 $filter（eq、ne、not、ge、le 和 null 值上的 eq）。 |
| keyCredentials | keyCredential 集合 | 与服务主体关联的密钥凭据的集合。不可为 null。支持 $filter （eq、 not、 ge、 le）。 |
| loginUrl | String | 指定服务提供商将用户重定向到 Azure AD 进行身份验证的 URL。 Azure AD 使用 URL 从 Microsoft 365 或Azure AD My Apps 启动应用程序。 该选项为空时，Azure AD 将对使用“基于 SAML 的单一登录”配置的应用程序执行 IdP 启动的登录。 用户从 Microsoft 365、Azure AD My Apps 或Azure AD SSO URL 启动应用程序。 |
| logoutUrl | String | 指定 Microsoft 授权服务使用 OpenId Connect 正向通道、反向通道或 SAML 注销协议注销用户时所使用的 URL。 |
| notes | String | 免费文本字段，用于捕获有关服务主体的信息，通常用于操作。最大允许大小为 1024 个字符。 |
| notificationEmailAddresses | 字符串集合 | 指定在活动证书临近到期日期时，Azure AD 在其中发送通知的电子邮件地址列表。 这仅适用于用于签署为 Azure AD 库应用程序发行的 SAML 令牌的证书。 |
| passwordCredentials | passwordCredential 集合 | 与服务帐户关联的密码凭据集合。不可为空。 |
| passwordSingleSignOnSettings | passwordSingleSignOnSettings | 有关密码单一登录的设置的集合。 使用 $select=passwordSingleSignOnSettings 读取属性。 对 applicationTemplates（自定义 applicationTemplates 除外）只读。 |
| preferredSingleSignOnMode | string | 指定为此应用程序配置的单一登录模式。 Azure AD 使用首选单一登录模式从 Microsoft 365 或Azure AD My Apps 启动应用程序。 支持的值是：password、saml、notSupported 和 oidc。 |
| preferredTokenSigningKeyEndDateTime | DateTimeOffset | 指定用于令牌签名的 keyCredential 的到期日期，由 preferredTokenSigningKeyThumbprint 标记。 |
| preferredTokenSigningKeyThumbprint | String | 仅供内部使用。 请勿写入属性，否则将依赖该属性。 可能会在未来版本中删除。 |
| publishedPermissionScopes | permissionScope 集合 | 应用程序公开的委派权限。 有关详细信息，请参阅 应用程序实体上的 api 属性的 oauth2PermissionScopes 属性。 不可为 null。 注意： 此属性在 v1.0 中命名为 oauth2PermissionScopes。 |
| replyUrls | String 集合 | 向其发送用户令牌以使用关联应用程序登录的 URL，或者为关联应用程序向其发送 OAuth 2.0 授权代码和访问令牌的重定向 URI。不可为 null。 |
| samlMetadataUrl | String | 服务用于公开联合身份验证的 SAML 元数据的 URL。 |
| samlSingleSignOnSettings | samlSingleSignOnSettings | 有关 saml 单一登录的设置的集合。 |
| servicePrincipalNames | 字符串集合 | 包含从关联的 应用程序中复制的 identifiersUris 列表。 可以将其他值添加到混合应用程序。 这些值可用于标识此应用程序在 Azure AD 中公开的权限。 例如，
多值属性上的筛选器表达式需要 any 运算符。不可为 NULL。 支持 $filter（eq、not、ge、le、startsWith）。 |
| servicePrincipalType | String | 标识服务主体是表示应用程序还是托管标识。 这是由 Azure AD 内部设置的。 对于表示 应用程序的服务主体，此选项设置为“Application”。 对于表示 托管标识的服务主体，此选项设置为“ManagedIdentity”。 SocialIdp 类型供内部使用。 |
| signInAudience | String | 指定当前应用程序支持的 Microsoft 帐户。只读。 支持的值为：
|
| tags | String collection | 可用于对服务主体进行分类和识别的自定义字符串。不可为空。 支持 $filter（eq、not、ge、le、startsWith）。 |
| tokenEncryptionKeyId | 字符串 | 指定 keyCredentials 集合中的公共密钥的 keyId。 配置后，Azure AD 为此应用程序发布使用此属性指定的密钥加密的令牌。 接收加密令牌的应用程序代码必须先使用匹配的私钥来解密该令牌，然后才能将该令牌用于登录用户。 |
| verifiedPublisher | verifiedPublisher | 指定该服务主体代表的应用程序的已验证发布者。 |
关系
| 关系 | 类型 | 说明 |
|---|---|---|
| appManagementPolicies | appManagementPolicy 集合 | 应用到此服务主体的 appManagementPolicy。 |
| appRoleAssignedTo | appRoleAssignment | 此应用或服务的应用角色分配，已授予用户、组和其他服务主体。支持 $expand。 |
| appRoleAssignments | appRoleAssignment 集合 | 另一个应用或服务的应用角色分配，授予此服务主体。支持 $expand。 |
| claimsMappingPolicies | claimsMappingPolicy 集合 | 分配给此服务主体的 claimsMappingPolicies。支持 $expand。 |
| createdObjects | directoryObject collection | 由此服务主体创建的目录对象。只读。空。 |
| delegatedPermissionClassifications | delegatedPermissionClassification 集合 | 此服务主体所表示的应用公开的委派权限的权限分类。支持 $expand。 |
| endpoints | endpoint 集合 | 可用于发现的终结点。SharePoint 等服务使用特定于租户的 SharePoint 终结点填充此属性，其他应用程序可在这些终结点的体验中发现和使用。 |
| homeRealmDiscoveryPolicies | homeRealmDiscoveryPolicy 集合 | 为此服务主体分配的 homeRealmDiscoveryPolicies。支持 $expand。 |
| memberOf | directoryObject 集合 | 此服务主体所属的角色。HTTP 方法：GET 只读。空。支持 $expand。 |
| oauth2PermissionGrants | oAuth2PermissionGrant 集合 | 委派权限授予设置此服务主体以代表已登录用户访问 API 的权限。只读。可为空。 |
| ownedObjects | directoryObject 集合 | 属于此服务主体的目录对象。只读。可为空。支持 $expand。 |
| owners | directoryObject 集合 | servicePrincipal 所述的目录对象。 所有者是一组允许修改此对象的非管理员用户或 servicePrincipal。 只读。 可为 NULL。 支持 $expand。 |
| tokenIssuancePolicies | tokenIssuancePolicy 集合 | 分配给此服务主体的 tokenIssuancePolicies。支持 $expand。 |
| tokenLifetimePolicies | tokenLifetimePolicy 集合 | 分配给此服务主体的 tokenLifetimePolicies。支持 $expand。 |
JSON 表示形式
{
"accountEnabled": true,
"addIns": [{"@odata.type": "microsoft.graph.addIn"}],
"alternativeNames": "String",
"appDisplayName": "String",
"appId": "String",
"appOwnerOrganizationId": "Guid",
"applicationTemplateId": "String",
"appRoleAssignmentRequired": true,
"appRoles": [{"@odata.type": "microsoft.graph.appRole"}],
"customSecurityAttributes": {
"@odata.type": "microsoft.graph.customSecurityAttributeValue"
},
"disabledByMicrosoftStatus": "String",
"displayName": "String",
"errorUrl": "String",
"homepage": "String",
"id": "String (identifier)",
"info": {"@odata.type": "microsoft.graph.informationalUrl"},
"keyCredentials": [{"@odata.type": "microsoft.graph.keyCredential"}],
"loginUrl": "String",
"logoutUrl": "String",
"notes": "String",
"notificationEmailAddresses": ["String"],
"publishedPermissionScopes": [{"@odata.type": "microsoft.graph.permissionScope"}],
"passwordCredentials": [{"@odata.type": "microsoft.graph.passwordCredential"}],
"passwordSingleSignOnSettings": {"@odata.type": "microsoft.graph.passwordSingleSignOnSettings"},
"preferredSingleSignOnMode": "String",
"preferredTokenSigningKeyEndDateTime": "DateTime",
"preferredTokenSigningKeyThumbprint": "String",
"replyUrls": ["String"],
"samlMetadataUrl": "String",
"samlSingleSignOnSettings": "microsoft.DirectoryServices.SamlSingleSignOnSettings",
"servicePrincipalNames": ["String"],
"servicePrincipalType": "String",
"signInAudience": "String",
"tags": ["String"],
"tokenEncryptionKeyId": "String",
"useCustomTokenSigningKey": false,
"verifiedPublisher": {"@odata.type": "microsoft.graph.verifiedPublisher"}
}
反馈
提交和查看相关反馈