openIdConnectIdentityProvider 资源类型

命名空间：microsoft.graph

重要

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

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

通过在 Azure AD B2C 租户中配置 OpenID Connect 提供程序，用户可以使用其自定义标识提供程序注册并登录到任何应用程序。

继承自 identityProviderBase。

方法

无。

有关在 Azure AD B2C 中管理 OpenID Connect 标识提供程序的 API 操作列表，请参阅 identityProviderBase 资源类型。

属性

属性 类型 说明
clientId 字符串 向标识提供程序注册应用程序时，获取应用程序的客户端标识符。 必填。
clientSecret 字符串 使用身份提供程序注册应用时获取的应用客户端密码。 clientSecret 依赖于 responseType。
  • 当 responseType 为 code时，身份验证代码交换需要机密。
  • 如果 responseType 为 id_token，则不需要机密，因为没有代码交换。 id_token直接从授权响应返回。
这是只读的。 读取操作返回 ****。
id String 标识提供程序的标识符。必需。 继承自 identityProviderBase。 只读。
displayName 字符串 标识提供程序的显示名称。
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 元数据文档始终位于以 结 .well-known/openid-configuration尾的终结点。 提供所添加的 OpenID Connect 标识提供程序的元数据 URL。 只读。 必填。
responseMode openIdConnectResponseMode 响应模式定义用于将数据从自定义标识提供程序发送回 Azure AD B2C 的方法。 可能的值： form_post， query。 必填。
responseType openIdConnectResponseTypes 响应类型描述在对自定义标识提供程序的authorization_endpoint的初始调用中发回的信息类型。 可能值： code 、、 id_tokentoken。 必填。
范围 String 范围定义要从自定义标识提供程序收集的信息和权限。 OpenID Connect 请求必须包含 openid 范围值，才能从标识提供程序接收 ID 令牌。 如果没有 ID 令牌，用户无法使用自定义标识提供程序登录到 Azure AD B2C。 可以追加其他作用域，用空格分隔。 有关范围限制的更多信息，请参阅 RFC6749 第 3.3 节。 必填。

openIdConnectResponseMode 值

成员 说明
form_post 建议使用此响应模式以获得最佳安全性。 响应通过 HTTP POST 方法传输，使用 application/x-www-form-urlencoded 格式在正文中对代码或令牌进行编码。
查询 代码或令牌作为查询参数返回。
unknownFutureValue 指示未来值的哨兵值。

openIdConnectResponseTypes 值

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

关系

无。

JSON 表示形式

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

{
  "@odata.type": "#microsoft.graph.openIdConnectIdentityProvider",
  "id": "String (identifier)",
  "displayName": "String",
  "clientId": "String",
  "clientSecret": "String",
  "scope": "String",
  "metadataUrl": "String",
  "domainHint": "String",
  "responseType": "String",
  "responseMode": "String",
  "claimsMapping": {
    "@odata.type": "microsoft.graph.claimsMapping"
  }
}
  • Last updated on