获取 identityProvider

命名空间:microsoft.graph

重要

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

获取租户中配置的指定标识提供者的属性和关系。

在派生自 identityProviderBase 的提供程序类型中,当前可以在 Microsoft Entra ID 中获取 socialIdentityProviderbuiltinIdentityProvider 资源。 在 Azure AD B2C 中,此操作当前可以获取 socialIdentityProvideropenIdConnectIdentityProviderappleManagedIdentityProvider 资源。

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

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

权限

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

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

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

HTTP 请求

GET /identity/identityProviders/{id}

请求标头

名称 说明
Authorization 持有者 {token}。 必填。 详细了解 身份验证和授权

请求正文

请勿提供此方法的请求正文。

响应

如果成功,此方法在200 OKMicrosoft Entra租户的响应正文中返回一个响应代码和 socialIdentityProviderbuiltinIdentityProvider 的 JSON 表示形式。

对于 Azure AD B2C 租户,此方法在响应正文中返回 200 OKsocialIdentityProvideropenIdConnectIdentityProviderappleManagedIdentityProvider 对象的响应代码和 JSON 表示形式。

示例

示例 1:检索特定社交标识提供者 (Microsoft Entra ID 或 Azure AD B2C)

请求

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

GET https://graph.microsoft.com/beta/identity/identityProviders/Amazon-OAUTH

响应

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

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

HTTP/1.1 200 OK
Content-type: application/json

{
    "id": "Amazon-OAUTH",
    "displayName": "Amazon",
    "identityProviderType": "Amazon",
    "clientId": "09876545678908765978678",
    "clientSecret": "******"
}

示例 2:仅检索特定内置标识提供者 (Microsoft Entra ID)

请求

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

GET https://graph.microsoft.com/beta/identity/identityProviders/MSASignup-OAUTH

响应

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

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

HTTP/1.1 200 OK
Content-type: application/json

{
    "id": "MSASignup-OAUTH",
    "identityProviderType": "MicrosoftAccount",
    "displayName": "MicrosoftAccount"
}

示例 3:检索特定 OpenID Connect 标识提供者 (仅适用于 Azure AD B2C)

请求

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

GET https://graph.microsoft.com/beta/identity/identityProviders/OIDC-V1-test-icm-4470de58-86c2-4a3f-a22c-63c9366cd000

响应

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

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

HTTP/1.1 200 OK
Content-type: application/json

{
  "@odata.type": "microsoft.graph.openIdConnectIdentityProvider",
  "id": "OIDC-V1-test-icm-4470de58-86c2-4a3f-a22c-63c9366cd000",
  "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"
}

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

请求

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

GET https://graph.microsoft.com/beta/identity/identityProviders/Apple-Managed-OIDC

响应

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

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

HTTP/1.1 200 OK
Content-type: application/json

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