创建 identityProvider

  • 项目

命名空间：microsoft.graph

重要

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

创建请求正文中指定的类型的标识提供者对象。

在派生自 identityProviderBase 的提供程序类型中，当前可以在 Microsoft Entra ID 中创建 socialIdentityProvider 资源。 在 Azure AD B2C 中，此操作当前可以创建 socialIdentityProvider、 openIdConnectIdentityProvider 或 appleManagedIdentityProvider 资源。

此 API 可用于以下国家级云部署。

全局服务 美国政府 L4 美国政府 L5 (DOD) 由世纪互联运营的中国
✅ ✅ ✅ ✅

权限

为此 API 选择标记为最低特权的权限。 只有在应用需要它时，才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息，请参阅权限类型。 要了解有关这些权限的详细信息，请参阅 权限参考。

权限类型 最低特权权限 更高特权权限
委派（工作或学校帐户） IdentityProvider.ReadWrite.All 不可用。
委派（个人 Microsoft 帐户） 不支持。 不支持。
应用程序 IdentityProvider.ReadWrite.All 不可用。

工作或学校帐户至少需要属于外部标识提供者管理员Microsoft Entra角色。

HTTP 请求

POST /identity/identityProviders

请求标头

名称 说明
Authorization 持有者 {token}。 必填。 详细了解 身份验证和授权。
Content-Type application/json. 必需。

请求正文

在请求正文中，在 Microsoft Entra ID 中提供 socialIdentityProvider 对象的 JSON 表示形式。

在 Azure AD 中，B2C 提供 socialIdentityProvider、 openIdConnectIdentityProvider 或 appleManagedIdentityProvider 对象的 JSON 表示形式。

下表中列出的所有属性均是必需的。

socialIdentityProvider 对象

属性 类型 说明
clientId 字符串 向标识提供程序注册应用程序时，获取应用程序的客户端标识符。
clientSecret 字符串 向标识提供程序注册时获取的应用程序的客户端密码。 这是只读的。 读取操作返回 ****。
displayName 字符串 标识提供程序的显示名称。
identityProviderType String 对于 B2B 方案，可能的值为： Google、 Facebook。 对于 B2C 方案，可能的值： Microsoft、 Google、 Amazon、 LinkedIn、 Facebook、 GitHub、 Twitter、 Weibo、 QQ、 WeChat。

openIdConnectIdentityProvider 对象

属性 类型 说明
clientId 字符串 使用身份提供程序注册应用时获取的应用客户端 ID。
clientSecret 字符串 使用身份提供程序注册应用时获取的应用客户端密码。 clientSecret 依赖于 responseType。
  • 当 responseType 为 code时，身份验证代码交换需要机密。
  • 当 responseType 为 id_token 机密时，由于没有代码交换，因此不需要机密时，id_token直接从授权响应返回。
displayName 字符串 标识提供程序的显示名称。
domainHint String 域提示可用于直接跳到指定标识提供者的登录页，而不是让用户在可用标识提供者列表中做出选择。
claimsMapping claimsMapping 在 OIDC 提供程序将 ID 令牌发送回Microsoft Entra ID后，Microsoft Entra ID需要能够将收到的令牌中的声明映射到Microsoft Entra ID识别和使用的声明。 此复杂类型捕获该映射。
metadataUrl String OpenID Connect 标识提供者的元数据文档的 URL。 每个 OpenID Connect 标识提供者都描述了一个元数据文档，其中包含执行登录所需的大部分信息。 这包括要使用的 URL 和服务公共签名密钥的位置等信息。 OpenID Connect 元数据文档始终位于 以 结尾的终结点。.well-known/openid-configuration 提供添加的 OpenID Connect 标识提供者的元数据 URL。
responseMode String 响应模式定义用于将数据从自定义标识提供者发送回 Azure AD B2C 的方法。 可能的值： form_post、 query。
responseType String 响应类型描述在初始调用中发送回自定义标识提供者authorization_endpoint的信息的类型。 可能的值： code 、 id_token 、 token。
范围 String 作用域定义要从自定义标识提供者收集的信息和权限。

appleIdentityProvider 对象

属性 类型 说明
displayName 字符串 标识提供程序的显示名称。
developerId String Apple 开发人员标识符。
服务 Id String Apple 服务标识符。
keyId String Apple 密钥标识符。
certificateData String 证书中长文本字符串的证书数据可能是 null。

响应

如果成功，此方法在201 CreatedMicrosoft Entra租户的响应正文中返回一个响应代码和 socialIdentityProvider 对象的 JSON 表示形式。

对于 Azure AD B2C 租户，此方法在响应正文中返回 201 CreatedsocialIdentityProvider、 openIdConnectIdentityProvider 或 appleManagedIdentityProvider 对象的响应代码和 JSON 表示形式。

如果失败，将返回 4xx 错误并显示具体详细信息。

示例

示例 1：创建特定的社交标识提供者 (Microsoft Entra ID 和 Azure AD B2C)

请求

以下示例显示了一个请求。

POST https://graph.microsoft.com/beta/identity/identityProviders
Content-type: application/json

{
  "@odata.type": "microsoft.graph.socialIdentityProvider",
  "displayName": "Login with Amazon",
  "identityProviderType": "Amazon",
  "clientId": "56433757-cadd-4135-8431-2c9e3fd68ae8",
  "clientSecret": "000000000000"
}

响应

以下示例显示了相应的响应。

注意：为了提高可读性，可能缩短了此处显示的响应对象。

HTTP/1.1 201 Created
Content-type: application/json

{
    "@odata.type": "microsoft.graph.socialIdentityProvider",
    "id": "Amazon-OAUTH",
    "displayName": "Login with Amazon",
    "identityProviderType": "Amazon",
    "clientId": "56433757-cadd-4135-8431-2c9e3fd68ae8",
    "clientSecret": "000000000000"
}

示例 2：仅针对 Azure AD B2C (创建特定的 OpenID Connect 标识提供者)

请求

以下示例显示了一个请求。

POST https://graph.microsoft.com/beta/identity/identityProviders
Content-type: application/json

{
  "@odata.type": "microsoft.graph.openIdConnectIdentityProvider",
    "displayName": "Login with the Contoso identity provider",
    "clientId": "56433757-cadd-4135-8431-2c9e3fd68ae8",
    "clientSecret": "12345",
    "claimsMapping": {
        "userId": "myUserId",
        "givenName": "myGivenName",
        "surname": "mySurname",
        "email": "myEmail",
        "displayName": "myDisplayName"
    },
    "domainHint": "mycustomoidc",
    "metadataUrl": "https://mycustomoidc.com/.well-known/openid-configuration",
    "responseMode": "form_post",
    "responseType": "code",
    "scope": "openid"
}

响应

以下示例显示了相应的响应。

注意：为了提高可读性，可能缩短了此处显示的响应对象。

HTTP/1.1 201 Created
Content-type: application/json

{
  "@odata.type": "microsoft.graph.openIdConnectIdentityProvider",
  "id": "OIDC-V1-MyTest-085a8a0c-58cb-4b6d-8e07-1328ea404e1a",
  "displayName": "Login with the Contoso identity provider",
  "clientId": "56433757-cadd-4135-8431-2c9e3fd68ae8",
  "clientSecret": "12345",
  "claimsMapping": {
      "userId": "myUserId",
      "givenName": "myGivenName",
      "surname": "mySurname",
      "email": "myEmail",
      "displayName": "myDisplayName"
  },
  "domainHint": "mycustomoidc",
  "metadataUrl": "https://mycustomoidc.com/.well-known/openid-configuration",
  "responseMode": "form_post",
  "responseType": "code",
  "scope": "openid"
}

示例 3：仅检索 Azure AD B2C) 的 Apple 标识提供者 (

请求

以下示例显示了一个请求。

POST https://graph.microsoft.com/beta/identity/identityProviders
Content-type: application/json

{
  "@odata.type": "microsoft.graph.appleManagedIdentityProvider",
  "displayName": "Sign in with Apple",
  "developerId": "UBF8T346G9",
  "serviceId": "com.microsoft.rts.b2c.test.client",
  "keyId": "99P6D879C4",
  "certificateData": "******"
}

响应

以下示例显示了相应的响应。

注意：为了提高可读性，可能缩短了此处显示的响应对象。

HTTP/1.1 201 Created
Content-type: application/json

{
  "@odata.type": "microsoft.graph.appleManagedIdentityProvider",
  "id": "Apple-Managed-OIDC",
  "displayName": "Sign in with Apple",
  "developerId": "UBF8T346G9",
  "serviceId": "com.microsoft.rts.b2c.test.client",
  "keyId": "99P6D879C4",
  "certificateData": "******"
}