identityApiConnector 资源类型

命名空间：microsoft.graph

重要

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

表示 Azure AD 租户和 Azure AD (Azure AD) Azure Active Directory 中的 API 连接器。

Azure AD 外部标识自助注册中使用的 API 连接器和 Azure AD B2C 注册用户流允许你在执行用户流期间调用 API。 API 连接器提供调用 API 时需要的信息，包括终结点 URL 和身份验证。 API 连接器可在用户流中的特定步骤使用，以影响用户流的执行。 例如，API 响应可以阻止用户注册、显示输入验证错误或覆盖用户收集的属性。

使用 b2xIdentityUserFlow API 从外部标识自助注册用户流使用 API 连接器。

方法

方法	返回类型	Description
List	identityApiConnector 集合	获取 API 连接器列表
创建	identityApiConnector	创建新的 API 连接器。
获取	identityApiConnector	读取 identityApiConnector 对象 的属性。
更新	identityApiConnector	更新 API 连接器的属性。
上载客户端证书	identityApiConnector	上载客户端证书以用于身份验证。
删除	无	删除 API 连接器。

属性

属性	类型	说明
id	字符串	API 连接器的随机生成的 ID。
displayName	字符串	API 连接器的名称。
targetUrl	字符串	要调用的 API 终结点的 URL。
authenticationConfiguration	apiAuthenticationConfigurationBase	描述用于调用 API 的身份验证配置详细信息的对象。 支持基本证书和 PKCS 12 客户端证书。

关系

无。

JSON 表示形式

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

{
  "@odata.type": "#microsoft.graph.identityApiConnector",
  "id": "String (identifier)",
  "displayName": "String",
  "targetUrl": "String",
  "authenticationConfiguration": {
    "@odata.type": "microsoft.graph.apiAuthenticationConfigurationBase"
  }
}