应用程序资源类型
命名空间：microsoft.graph
重要
Microsoft Graph版本下的 /beta API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用，请使用 版本 选择器。
表示应用程序。 任何将身份验证外包到 Azure Active Directory (Azure AD) 的应用程序都必须在目录中注册。 应用程序注册涉及告知 Azure AD 有关应用程序的信息，包括其所在的 URL、身份验证后发送回复的 URL、标识应用程序的 URI 等。 有关详细信息，请参阅在 Azure AD 中注册应用程序的基础知识。 继承自 directoryObject。
此资源是允许传入其他属性的开放类型。
备注
对应用程序资源类型的更改目前正在开发中。 有关详细信息，请参阅 Microsoft Graph 的已知问题。
该资源支持：
方法
属性
重要
仅当使用设置为 eventual 和 $count 的 ConsistencyLevel 标头时，才支持 $filter 和 $search 查询参数的特定用法。 有关详细信息，请参阅 Azure AD 目录对象的高级查询功能。
| 属性 | 类型 | Description |
|---|---|---|
| addIns | addIn 集合 | 定义使用服务可用于调用特定上下文中的应用的自定义行为。 例如，呈现文件流的应用程序可能会为其“FileHandler”功能设置 addIns 属性。 这将使 Office 365 之类的服务在用户正在处理的文档上下文中调用应用程序。 |
| api | apiApplication | 指定实现 Web API 的应用程序的设置。 |
| appId | String | Azure AD 分配给应用程序的唯一标识符。不可为 Null。只读。 |
| applicationTemplateId | String | applicationTemplate 的唯一标识符。支持 $filter （eq、 not、 ne）。 |
| appRoles | appRole 集合 | 分配给应用程序的角色的集合。 使用应用角色分配，可将这些角色分配给与其他应用程序关联的用户、组或服务主体。 不可为空。 |
| 认证 | 认证 | 指定应用程序的认证状态。 |
| createdDateTime | DateTimeOffset | 注册应用程序的日期和时间。DateTimeOffset 类型表示使用 ISO 8601 格式的日期和时间信息，并且始终采用 UTC 时间。例如，2014 年 1 月 1 日午夜 UTC 为 2014-01-01T00:00:00Z。只读。 支持 $filter (eq、ne、not、ge、le、in 和 null 值上的 eq) 和 $orderBy。 |
| defaultRedirectUri | String | 默认重定向 URI。 如果指定，并且 SAML 和 OIDC 流的登录请求中不存在显式重定向 URI，则 Azure AD 将令牌发送到此重定向 URI。 Azure AD 还会在 SAML IdP 发起的单一登录中将令牌发送到此默认 URI。 该值必须与为应用程序配置的重定向 URI 之一匹配。 |
| deletedDateTime | DateTimeOffset | 删除应用程序的日期和时间。DateTimeOffset 类型表示使用 ISO 8601 格式的日期和时间信息，并且始终采用 UTC 时间。例如，2014 年 1 月 1 日午夜 UTC 为 2014-01-01T00:00:00Z。只读。 |
| 说明 | String | 用于向最终用户提供应用程序对象说明的空闲文本字段。 最大允许大小为 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。 |
| groupMembershipClaims | String | 配置应用程序预期的用户或 OAuth 2.0 访问令牌中发出的 groups 声明。要设置此属性，请使用以下字符串值之一：None、SecurityGroup（对于安全组和 Azure AD 角色）和 All （这将获取登录用户所属的所有安全组、通讯组和 Azure AD 目录角色）。 |
| id | 字符串 | 应用程序对象的唯一标识符。 此属性在Azure 门户中称为 对象 ID。 继承自 directoryObject。 键。 不可为 null。 只读。 支持 $filter （eq、 ne、 not、 in）。 |
| identifierUris | String collection | 也称为应用 ID URI，此值在将应用程序用作资源应用时设置。 identifierUris 可充当你将在 API 代码中引用的范围的前缀，必须具有全局唯一性。 可以使用提供的默认值（采用 api://<application-client-id> 形式）或指定更具有可读性的 URI（如 https://contoso.com/api）。 有关有效 identifierUris 模式和最佳做法的信息，请参阅 Azure AD 应用程序注册安全性最佳做法。 不可为 null。 支持 $filter（eq、ne、ge、le、startsWith）。 |
| info | informationalUrl | 应用程序的基本配置文件信息，如应用的市场营销、支持、服务条款和隐私声明 URL。 服务条款和隐私声明通过用户同意体验展示给用户。 有关详细信息，请参阅如何：为已注册的 Azure AD 应用添加服务条款和隐私声明。 支持 $filter (eq、ne、not、ge、le 和 null 值上的 eq)。 |
| isDeviceOnlyAuthSupported | 布尔值 | 指定此应用程序是否支持在无用户的情况下进行设备身份验证。默认值为 false。 |
| isFallbackPublicClient | Boolean | 将回退应用程序类型指定为公共客户端，例如在移动设备上运行的已安装应用程序。 默认值为 false，这意味着，回退应用程序类型为机密客户端，例如 Web 应用。 某些情况下，Azure AD 无法确定客户端应用程序类型。 例如，在未指定重定向 URI 的情况下配置应用程序的 ROPC 流。 在这种情况下，Azure AD 将基于此属性的值解释应用程序类型。 |
| keyCredentials | keyCredential 集合 | 与应用程序关联的密钥凭据集合。不可为 Null。支持 $filter（eq、not、ge、le）。 |
| logo | Stream | 应用程序的主徽标。不可为 Null。 |
| notes | String | 与应用程序管理相关的备注。 |
| oauth2RequiredPostResponse | Boolean | 指定在 OAuth 2.0 令牌请求过程中，Azure AD 是否允许与 GET 请求相反的 POST 请求。 默认值为 false，即指定只允许 GET 请求。 |
| onPremisesPublishing | onPremisesPublishing | 表示为此应用程序配置应用程序代理所需的属性集。 配置这些属性允许你发布本地应用程序以实现安全远程访问。 |
| optionalClaims | optionalClaims | 应用程序开发人员可以在其 Azure AD 应用程序中配置可选声明，以指定由 Microsoft security token service 发送到其应用程序的声明。有关详细信息，请参阅 如何：向应用提供可选声明。 |
| parentalControlSettings | parentalControlSettings | 指定应用程序的家长控制设置。 |
| passwordCredentials | passwordCredential 集合 | 与应用程序关联的密码凭据集合。不可为 Null。 |
| publicClient | publicClientApplication | 指定已安装客户端（如台式设备或移动设备）的设置。 |
| publisherDomain | String | 应用程序的已验证发布者域。只读。支持 $filter（eq、ne、ge、le、startsWith）。 |
| requiredResourceAccess | requiredResourceAccess 集合 | 指定应用程序需要访问的资源。 此属性还指定每个资源所需的委派权限和应用程序角色的集合。 该配置对所需的资源的访问将推动许可体验。 可配置的资源服务 (API) 不能超过 50 个。 从 2021 年 10 月中旬开始，所需权限总数不得超过 400 个。 不可为 null。 支持 $filter（eq、not、ge、le）。 |
| samlMetadataUrl | String | 服务用于公开联合身份验证的 SAML 元数据的 URL。 此属性仅对单租户应用程序有效。 可为 Null。 |
| serviceManagementReference | 字符串 | 引用服务或资产管理数据库中的应用程序或服务联系人信息。可为空。 |
| signInAudience | String | 指定当前应用程序支持的 Microsoft 帐户。 可能的值是：AzureADMyOrg、AzureADMultipleOrgs、AzureADandPersonalMicrosoftAccount（默认）和 PersonalMicrosoftAccount。 请参阅下表中的 ，了解。 支持 $filter（eq、ne、not）。 |
| spa | spaApplication | 指定单页应用程序的设置，包括注销 URL 并重定向授权代码和访问令牌的 URI。 |
| 标记 | 字符串集合 | 可用于分类和标识应用程序的自定义字符串。不可为 null。 支持 $filter（eq、not、ge、le、startsWith）。 |
| tokenEncryptionKeyId | Guid | 指定 keyCredentials 集合中的公共密钥的 keyId。 配置后，Azure AD 将使用此属性指向的密钥对其发出的所有令牌进行加密。 接收加密令牌的应用程序代码必须先使用匹配的私钥来解密该令牌，然后才能将该令牌用于登录用户。 |
| verifiedPublisher | verifiedPublisher | 指定应用程序的已验证发布者。有关发布者验证如何帮助支持应用程序安全性、可信度和合规性的详细信息，请参阅 发布者验证。 |
| 唯一名称 | String | 可指定给应用程序作为替代标识符的唯一标识符。不可变。只读。 |
| web | webApplication | 指定 Web 应用程序的设置。 |
| windows | windowsApplication | 指定运行 Microsoft Windows 并在 Microsoft Store 或 Xbox 游戏商店中发布的应用的设置。 |
signInAudience 值
| 值 | 说明 |
|---|---|
| AzureADMyOrg | 在我的组织的 Azure AD 租户（单租户）中拥有 Microsoft 工作或学校帐户的用户。 |
| AzureADMultleOrgs | 拥有任何组织的 Azure AD 租户（多租户）中 Microsoft 工作或学校帐户的用户。 |
| AzureADandPersonalMicrosoftAccount | 具有个人 Microsoft 帐户或任何组织的 Azure AD 租户中的工作或学校帐户的用户。 要使用 Azure Active Directory B2C 用户流程对用户进行身份验证，请使用 AzureADandPersonalMicrosoftAccount。 该值允许最广泛的用户标识集，包括本地账户和 Microsoft、Facebook、谷歌、Twitter 或任何 OpenID Connect 提供商的用户标识。 这是 signInAudience 属性的默认值。 |
| PersonalMicrosoftAccount | 仅具有个人 Microsoft 帐户的用户。 |
关系
| 关系 | 类型 | 说明 |
|---|---|---|
| appManagementPolicies | appManagementPolicy 集合 | 应用到此应用程序的 appManagementPolicy。 |
| calls | call 集合 | 只读。可为 Null。 |
| connectorGroup | connectorGroup | 应用程序与 Azure AD 应用程序代理一起使用的 connectorGroup。可为 Null。 |
| createdOnBehalfOf | directoryObject | 只读。 |
| extensionProperties | extensionProperty 集合 | 只读。 可为 NULL。 支持 $expand 和 $filter（eq - 当计数空集合时）。 |
| federatedIdentityCredentials | federatedIdentityCredential 集合 | 应用程序的联合标识。 支持 $expand 和 $filter（eq - 当计数空集合时）。 |
| onlineMeetings | onlineMeeting 集合 | 只读。可为 Null。 |
| owners | directoryObject 集合 | 拥有此应用程序的目录对象。只读。可为 Null。支持 $expand。 |
| tokenLifetimePolicies | tokenLifetimePolicy 集合 | 为此应用分配的 tokenLifetimePolicies。支持 $expand。 |
JSON 表示形式
下面是资源的 JSON 表示形式。
{
"addIns": [{"@odata.type": "microsoft.graph.addIn"}],
"api": {"@odata.type": "microsoft.graph.apiApplication"},
"appId": "String",
"applicationTemplateId": "String",
"appRoles": [{"@odata.type": "microsoft.graph.appRole"}],
"certification": {"@odata.type": "microsoft.graph.certification"},
"createdDateTime": "String (timestamp)",
"deletedDateTime": "String (timestamp)",
"disabledByMicrosoftStatus": "String",
"displayName": "String",
"groupMembershipClaims": "String",
"id": "String (identifier)",
"identifierUris": ["String"],
"info": {"@odata.type": "microsoft.graph.informationalUrl"},
"isDeviceOnlyAuthSupported": false,
"isFallbackPublicClient": false,
"keyCredentials": [{"@odata.type": "microsoft.graph.keyCredential"}],
"logo": "Stream",
"notes": "String",
"oauth2RequiredPostResponse": false,
"optionalClaims": {"@odata.type": "microsoft.graph.optionalClaims"},
"parentalControlSettings": {"@odata.type": "microsoft.graph.parentalControlSettings"},
"passwordCredentials": [{"@odata.type": "microsoft.graph.passwordCredential"}],
"publicClient": {"@odata.type": "microsoft.graph.publicClientApplication"},
"publisherDomain": "String",
"requiredResourceAccess": [{"@odata.type": "microsoft.graph.requiredResourceAccess"}],
"serviceManagementReference": "String",
"signInAudience": "String",
"spa": {"@odata.type": "microsoft.graph.spaApplication"},
"tags": ["String"],
"tokenEncryptionKeyId": "String",
"uniqueName": "String",
"verifiedPublisher": {"@odata.type": "microsoft.graph.verifiedPublisher"},
"web": {"@odata.type": "microsoft.graph.webApplication"},
"windows": {"@odata.type": "microsoft.graph.windowsApplication"}
}
反馈
提交和查看相关反馈