Partilhar via


Obter identityProvider

Namespace: microsoft.graph

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.

Obtenha as propriedades e relações do fornecedor de identidade especificado configurado no inquilino.

Entre os tipos de fornecedores derivados de identityProviderBase, no Microsoft Entra, esta operação pode obter um recurso socialIdentityProvider, appleManagedIdentityProvider (apenas inquilino externo), builtinIdentityProvider ou um recurso oidcIdentityProvider (apenas inquilino externo).

No Azure AD B2C, esta operação pode obter um recurso socialIdentityProvider, appleManagedIdentityProvider, builtinIdentityProvider ou openIdConnectIdentityProvider.

Esta API está disponível nas seguintes implementações de cloud nacionais.

Serviço global US Government L4 US Government L5 (DOD) China operada pela 21Vianet

Permissões

Escolha a permissão ou permissões marcadas como menos privilegiadas para esta API. Utilize uma permissão ou permissões com privilégios mais elevados apenas se a sua aplicação o exigir. Para obter detalhes sobre as permissões delegadas e de aplicação, veja Tipos de permissão. Para saber mais sobre estas permissões, veja a referência de permissões.

Tipo de permissão Permissões com menos privilégios Permissões com privilégios superiores
Delegado (conta corporativa ou de estudante) IdentityProvider.Read.All IdentityProvider.ReadWrite.All
Delegada (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Application IdentityProvider.Read.All IdentityProvider.ReadWrite.All

A conta escolar ou profissional tem de pertencer, pelo menos, ao Administrador do Fornecedor de Identidade Externa ou administrador de Fluxo de Utilizador de Identidade ExternaMicrosoft Entra função.

Solicitação HTTP

GET /identity/identityProviders/{id}

Cabeçalhos de solicitação

Nome Descrição
Autorização {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.

Corpo da solicitação

Não forneça um corpo de solicitação para esse método.

Resposta

Se for bem-sucedido, este método devolve um 200 OK código de resposta e uma representação JSON de um socialIdentityProvider, appleManagedIdentityProvider, builtinIdentityProvider ou oidcIdentityProvider no corpo da resposta para uma força de trabalho ou inquilino externo.

Para um Azure AD inquilino B2C, este método devolve um 200 OK código de resposta e uma representação JSON de um objeto socialIdentityProvider, openIdConnectIdentityProvider, appleManagedIdentityProvider ou um objeto builtinIdentityProvider no corpo da resposta.

Exemplos

Exemplo 1: Obter um fornecedor de identidade social

Solicitação

O exemplo a seguir mostra uma solicitação.

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

Resposta

O exemplo a seguir mostra a resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

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

{
    "id": "Amazon-OAUTH",
    "displayName": "Amazon",
    "identityProviderType": "Amazon",
    "clientId": "qazx.1234",
    "clientSecret": "******"
}

Exemplo 2: Obter um fornecedor de identidade incorporado

Solicitação

O exemplo a seguir mostra uma solicitação.

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

Resposta

O exemplo a seguir mostra a resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

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

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

Exemplo 3: Obter um fornecedor de identidade da Apple

Solicitação

O exemplo a seguir mostra uma solicitação.

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

Resposta

O exemplo a seguir mostra a resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

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

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

Exemplo 4: Obter um fornecedor de identidade do OpenID Connect (Azure AD inquilino B2C)

Solicitação

O exemplo a seguir mostra uma solicitação.

GET https://graph.microsoft.com/beta/identity/identityProviders/Contoso-00001111-aaaa-2222-bbbb-3333cccc4444

Resposta

O exemplo a seguir mostra a resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

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

{
  "@odata.type": "microsoft.graph.openIdConnectIdentityProvider",
  "id": "Contoso-00001111-aaaa-2222-bbbb-3333cccc4444",
  "displayName": "Contoso",
  "clientId": "00001111-aaaa-2222-bbbb-3333cccc4444",
  "clientSecret": "4294967296",
  "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"
}

Exemplo 5: Obter um fornecedor de identidade OIDC (Inquilino externo)

Solicitação

O exemplo a seguir mostra uma solicitação.

GET https://graph.microsoft.com/beta/identity/identityProviders/12345678-abcd-1234-cdef-aaaaaaaaaaaa

Resposta

O exemplo a seguir mostra a resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

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

{
  "@odata.type": "#microsoft.graph.OidcIdentityProvider",
  "id": "12345678-abcd-1234-cdef-aaaaaaaaaaaa",
  "displayName": "Contoso",
  "clientId": "00001111-aaaa-2222-bbbb-3333cccc4444",
  "issuer": "https://contoso.b2clogin.com/00001111-aaaa-2222-bbbb-3333cccc4444/v2.0/",
  "wellKnownEndpoint": "https://contoso.b2clogin.com/contoso.onmicrosoft.com/v2.0/.well-known/openid-configuration?p=B2C_1A_SIGNINEMAIL",
  "responseType": "code",
  "scope": "openid profile email offline_access",
  "clientAuthentication": {
    "@odata.type": "#microsoft.graph.OIDCClientSecretAuthentication",
    "clientSecret": "12345"
  },
  "inboundClaimMapping": {
    "sub": "sub",
    "name": "name",
    "given_name": "given_name",
    "family_name": "family_name",
    "email": "email",
    "email_verified": "email_verified",
    "phone_number": "phone_number",
    "phone_number_verified": "phone_number_verified",
    "address": {
      "street_address": "street_address",
      "locality": "locality",
      "region": "region",
      "postal_code": "postal_code",
      "country": "country"
    }
  }
}