openIdConnectIdentityProvider 资源类型

命名空间：microsoft.graph

重要

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

表示 Azure AD 连接 B2C Azure Active Directory (中的 OpenID) 标识提供程序。

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

继承自 identityProviderBase。

方法

方法	返回类型	Description
List	identityProviderBase 集合	检索在租户中配置的所有标识提供程序，包括 openIdConnectIdentityProvider 对象类型。 无法仅检索租户中的 OpenID 连接提供程序。
Create	openIdConnectIdentityProvider	创建新的 openIdConnectIdentityProvider 对象。
Get	openIdConnectIdentityProvider	检索 openIdConnectIdentityProvider 对象 的属性。
更新	无	更新 openIdConnectIdentityProvider 对象。
删除	无	删除 openIdConnectIdentityProvider 对象。
列出可用的提供程序类型	String 集合	检索租户中所有可用的标识提供程序类型。

属性

属性	类型	说明
clientId	字符串	向标识提供程序注册应用程序时获取的应用程序的客户端标识符。必需。
clientSecret	字符串	使用身份提供程序注册应用时获取的应用客户端密码。 clientSecret 依赖于 responseType。 当 responseType code 为 时，身份验证代码交换需要密码。 当 responseType id_token 为密码时不是必需的，因为没有代码交换。 直接id_token授权响应返回该错误。 这是只读的。 读取操作返回 ****。
id	String	标识提供程序的标识符。必填。 继承自 identityProviderBase。 只读。
displayName	字符串	标识提供程序的显示名称。
claimsMapping	claimsMapping	OIDC 提供程序将 ID 令牌发送回 Azure AD 后，Azure AD 需要能够将收到的令牌中的声明映射到 Azure AD 识别和使用声明。 此复杂类型捕获该映射。 必需项。
domainHint	String	域提示可用于直接跳到指定标识提供程序的登录页面，而不是让用户在可用标识提供程序列表中进行选择。
metadataUrl	String	OpenID 元数据文档的 URL 连接标识提供程序。 每个 OpenID 连接标识提供程序都描述一个元数据文档，其中包含执行登录所需的大部分信息。 这包括要使用的 URL 以及服务的公共签名密钥的位置等信息。 OpenID 连接元数据文档始终位于 以 结尾的终结点 .well-known/openid-configuration 。 提供您添加的 OpenID 连接标识提供程序的元数据 URL。 只读。 必需。
responseMode	openIdConnectResponseMode	响应模式定义用于将数据从自定义标识提供程序发送回 Azure AD B2C 的方法。 可能的值 form_post query ：、。 必需项。
responseType	openIdConnectResponseTypes	响应类型描述在首次调用自定义标识提供程序的 authorization_endpoint 时发送回的信息类型。 可能的值 code id_token token ：、、。 必需项。
scope	String	范围定义要从自定义标识提供程序收集的信息和权限。 OpenID 连接请求必须包含 openid 范围值才能从标识提供程序接收 ID 令牌。 如果没有 ID 令牌，用户将无法使用自定义标识提供程序登录到 Azure AD B2C。 其他范围可以追加，用空格分隔。 有关范围限制的更多详细信息，请参阅 RFC6749 第 3.3 节。 必需项。

openIdConnectResponseMode 值

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

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"
  }
}