Criar identityProvider

Namespace: microsoft.graph

Crie um objeto de provedor de identidade do tipo especificado no corpo da solicitação.

Entre os tipos de provedores derivados de identityProviderBase, você pode criar atualmente um recurso socialIdentityProvider no Microsoft Entra ID. No Azure AD B2C, essa operação pode atualmente criar um recurso socialIdentityProvider ou um recurso appleManagedIdentityProvider.

Essa API está disponível nas seguintes implantações de nuvem nacional.

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

Permissões

Escolha a(s) permissão(s) marcada(s) como menos privilegiada(s) para essa API. Use uma permissão ou permissões com privilégios mais altos somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.

Tipo de permissão Permissões menos privilegiadas Permissões com privilégios mais elevados
Delegada (conta corporativa ou de estudante) IdentityProvider.ReadWrite.All Indisponível.
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Application IdentityProvider.ReadWrite.All Indisponível.

Importante

Para acesso delegado usando contas corporativas ou de estudante, o usuário conectado deve receber uma função do Microsoft Entra com suporte ou uma função personalizada que conceda as permissões necessárias para esta operação. O Administrador de Provedor de Identidade Externo é a função com menos privilégios com suporte para esta operação.

Solicitação HTTP

POST /identity/identityProviders

Cabeçalhos de solicitação

Nome Descrição
Autorização {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
Content-Type application/json. Obrigatório.

Corpo da solicitação

No corpo da solicitação, forneça uma representação JSON do objeto socialIdentityProvider no Microsoft Entra ID.

No Azure AD B2C, forneça uma representação JSON de socialIdentityProvider ou um objeto appleManagedIdentityProvider.

objeto socialIdentityProvider

Propriedade Tipo Descrição
clientId Cadeia de caracteres O identificador do cliente para o aplicativo obtido ao registrar o aplicativo com o provedor de identidade.
clientSecret Cadeia de caracteres O segredo do cliente para o aplicativo obtido quando o aplicativo é registrado com o provedor de identidade. Isso é somente gravação. Uma operação de leitura retorna ****.
displayName Cadeia de caracteres O nome de exibição exclusivo do provedor de identidade.
identityProviderType Cadeia de caracteres Para um cenário B2B, valores possíveis: Google, Facebook. Para um cenário B2C, valores possíveis: Microsoft, Google, Amazon, LinkedIn, Facebook, GitHub, Twitter, Weibo, QQ, WeChat.
scope Cadeia de caracteres O escopo define as informações e permissões que você deseja coletar de seu provedor de identidade personalizada.

objeto appleIdentityProvider

Propriedade Tipo Descrição
displayName Cadeia de caracteres O nome de exibição exclusivo do provedor de identidade.
developerId Cadeia de caracteres O Identificador de desenvolvedor da Apple.
serviceId Cadeia de caracteres O identificador de serviço da Apple.
keyId Cadeia de caracteres O identificador de chave da Apple.
certificateData Cadeia de caracteres Os dados do certificado, que são uma longa sequência de texto do certificado, podem ser nulos.

Resposta

Se for bem-sucedido, esse método retornará um 201 Created código de resposta e uma representação JSON de um objeto socialIdentityProvider no corpo da resposta para um locatário do Microsoft Entra.

Para um locatário do Azure AD B2C, esse método retorna um 201 Created código de resposta e uma representação JSON de um objeto socialIdentityProvider ou appleManagedIdentityProvider no corpo da resposta.

Caso não consiga, um 4xx erro será retornado com detalhes específicos.

Exemplos

Exemplo 1: Criar um provedor de identidade social específico (Microsoft Entra ID e Azure AD B2C)

Solicitação

O exemplo a seguir mostra uma solicitação.

POST https://graph.microsoft.com/v1.0/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"
}

Resposta

O exemplo a seguir mostra a resposta.

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

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

Exemplo 2: Criar provedor de identidade da Apple (somente para o Azure AD B2C)

Solicitação

O exemplo a seguir mostra uma solicitação.

POST https://graph.microsoft.com/v1.0/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": "******"
}

Resposta

O exemplo a seguir mostra a resposta.

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

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