openIdConnectProvider 资源类型 (已弃用)

命名空间：microsoft.graph

重要

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

警告

此标识提供程序 API 已弃用，并将在 2023 年 3 月之后停止返回数据。 请使用新的 标识提供程序 API。

表示 Azure Active Directory B2C 租户中的 OpenID Connect 标识提供者。

在 B2C 租户中配置 OpenID Connect 提供程序使用户能够在应用程序中使用其自定义标识提供者进行注册和登录。

继承自 identityProvider。

方法

方法	返回类型	Description
List	identityProvider 集合	检索在租户中配置的所有标识提供程序。
创建	openIdConnectProvider	创建新的 OpenID Connect 标识提供者。
Get	openIdConnectProvider	检索 OpenID Connect 标识提供者的属性。
更新	无	更新 OpenID Connect 标识提供者。
删除	无	删除 OpenID Connect 标识提供者。
列出可用的提供程序类型	String 集合	检索所有可用的身份提供程序类型。

属性

属性	类型	说明
clientId	字符串	向标识提供程序注册应用程序时，获取应用程序的客户端标识符。 继承自 identityProvider。 这是必需属性。
clientSecret	字符串	使用身份提供程序注册应用时获取的应用客户端密码。 clientSecret 依赖于 responseType。 当 responseType 为 code时，身份验证代码交换需要机密。 如果由于没有代码交换而不需要 responseType 机密 id_token ，则 id_token 直接从授权响应返回 。 这是只读的。 读取操作返回“****”。 继承自 identityProvider。
id	字符串	标识提供程序的 ID。 它是必需属性，在创建后是只读的。
name	字符串	标识提供程序的显示名称。 它是必需属性，在创建后是只读的。
type	字符串	标识提供程序类型。 它必须为 OpenIDConnect。 它是必需属性，在创建后是只读的。
claimsMapping	claimsMapping	在 OIDC 提供程序将 ID 令牌发送回Microsoft Entra ID后，Microsoft Entra ID需要能够将收到的令牌中的声明映射到Microsoft Entra ID识别和使用的声明。 此复杂类型捕获该映射。 这是必需属性。
domainHint	String	域提示可用于直接跳到指定标识提供者的登录页，而不是让用户在可用标识提供者列表中做出选择。
metadataUrl	String	OpenID Connect 标识提供者的元数据文档的 URL。 每个 OpenID Connect 标识提供者都描述了一个元数据文档，其中包含执行登录所需的大部分信息。 这包括要使用的 URL 和服务公共签名密钥的位置等信息。 OpenID Connect 元数据文档始终位于以已知/openid-configuration 结尾的终结点。 对于要添加的 OpenID Connect 标识提供者，需要提供元数据 URL。 它是必需属性，在创建后是只读的。
responseMode	openIdConnectResponseMode	响应模式定义用于将数据从自定义标识提供者发送回 Azure AD B2C 的方法。 可以使用以下响应模式： form_post、 query。 query 响应模式表示代码或令牌作为查询参数返回。 form_post 为了获得最佳安全性，建议使用响应模式。 响应通过 HTTP POST 方法传输，代码或令牌使用 application/x-www-form-urlencoded 格式在正文中编码。 这是必需属性。
responseType	openIdConnectResponseTypes	响应类型描述在对自定义标识提供者authorization_endpoint的初始调用中发送回的信息类型。 可以使用以下响应类型： code 、 id_token 、 token。 这是必需属性。
范围	String	范围定义要从自定义标识提供者收集的信息和权限。 OpenID Connect 请求必须包含 openid 范围值才能从标识提供者接收 ID 令牌。 如果没有 ID 令牌，用户将无法使用自定义标识提供者登录到 Azure AD B2C。 其他范围可以追加以空格分隔。 有关范围限制的详细信息，请参阅 RFC6749第 3.3 节。 这是必需属性。

openIdConnectResponseTypes 值

成员	说明
code	根据授权代码流，代码将返回到 Azure AD B2C。 Azure AD B2C 继续调用 token_endpoint以交换令牌的代码。
id_token	ID 令牌从自定义标识提供者返回到 Azure AD B2C。
令牌	访问令牌从自定义标识提供者返回到 Azure AD B2C。 Azure AD B2C 目前不支持。

JSON 表示形式

以下 JSON 表示形式显示了资源类型。

{
  "id": "String",
  "name": "String",
  "type": "String",
  "clientId": "String",
  "clientSecret": "String",
  "claimsMapping": {
      "@odata.type": "#microsoft.graph.claimsMapping",
      "userId": "String",
      "givenName": "String",
      "surname": "String",
      "email": "String",
      "displayName": "String"
  },
  "domainHint": "String",
  "metadataUrl": "String",
  "responseMode": "String",
  "responseType": "String",
  "scope": "String"
}