oidcIdentityProvider 资源类型

命名空间:microsoft.graph

重要

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

表示Microsoft Entra外部租户中的 OpenID Connect 标识提供者。

在外部租户中配置 OpenID Connect 提供程序使用户能够使用其自定义 OpenID Connect 标识提供者注册和登录到任何应用程序。

继承自 identityProviderBase

方法

无。

有关用于管理 oidcIdentityProvider 资源的 API 操作列表,请参阅 identityProviderBase 资源类型。

属性

属性 类型 说明
clientAuthentication oidcClientAuthentication 客户端身份验证设置。
  • 使用 oidcClientSecretAuthentication 派生的复杂类型通过 或 client_secret_jwt authentication 方法设置标识提供者client_secret_post
  • 使用 oidcPrivateJwtKeyClientAuthentication 类型通过身份验证方法设置标识提供者 private_key_jwt

    出于安全原因, client_secret_basic 不支持身份验证方法。
  • clientId 字符串 使用身份提供程序注册应用时获取的应用客户端 ID。
    displayName 字符串 标识提供程序的显示名称。 继承自 identityProviderBase
    id String 标识提供者的标识符。必填。 继承自 identityProviderBase。 继承自 实体
    inboundClaimMapping oidcInboundClaimMappingOverride OIDC 提供程序将 ID 令牌发送回Microsoft Entra 外部 ID后,Microsoft Entra 外部 ID需要能够将收到的令牌中的声明映射到Microsoft Entra ID识别和使用的声明。 此复杂类型捕获该映射。
    发行 String 颁发者 URI。 颁发者 URI 是一个区分大小写的 URL,使用 https 方案包含方案、主机和(可选)端口号和路径组件,并且没有查询或片段组件。
    注意:目前不支持将其他Microsoft Entra租户配置为外部标识提供者。 因此, microsoftonline.com 不接受颁发者 URI 中的域。
    responseType oidcResponseType 响应类型描述在初始调用中发送回自定义标识提供者authorization_endpoint的信息的类型。 可能的值:
  • code:根据授权代码流,代码将返回到 Entra 外部 ID。 Entra 外部 ID继续调用token_endpoint以交换令牌的代码。
  • id_token:ID 令牌从自定义标识提供者返回到 Entra 外部 ID。 () 时不支持此值。
  • token:访问令牌从自定义标识提供者返回到 Entra 外部 ID。 此值当前不受支持。
  • 范围 String 作用域定义要从自定义标识提供者收集的信息和权限。
    wellKnownEndpoint String OpenID Connect 标识提供者的元数据文档的 URL。 每个 OpenID Connect 标识提供者都描述了一个元数据文档,其中包含执行登录所需的大部分信息。 这包括要使用的 URL 和服务公共签名密钥的位置等信息。 OpenID Connect 元数据文档始终位于 以 结尾的终结点。.well-known/openid-configuration
    注意:元数据文档至少应包含以下属性:issuer、、authorization_endpointtoken_endpointtoken_endpoint_auth_methods_supportedresponse_types_supportedsubject_types_supportedjwks_uri。 有关更多详细信息,请访问 OpenID Connect 发现 规范。

    关系

    无。

    JSON 表示形式

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

    {
      "@odata.type": "#microsoft.graph.oidcIdentityProvider",
      "id": "String (identifier)",
      "displayName": "String",
      "supportedTenantTypes": "String",
      "clientId": "String",
      "issuer": "String",
      "wellKnownEndpoint": "String",
      "responseType": "String",
      "scope": "String",
      "clientAuthentication": {
        "@odata.type": "microsoft.graph.oidcClientAuthentication"
      },
      "inboundClaimMapping": {
        "@odata.type": "microsoft.graph.oidcInboundClaimMappingOverride"
      }
    }