Compartilhar via

Tutorial: Desenvolver e planejar o provisionamento para um ponto de extremidade do SCIM no Microsoft Entra ID

  • Artigo

Como desenvolvedor de aplicativos, você pode usar a API de gerenciamento de usuários do SCIM (Sistema de Gerenciamento de Usuários entre Domínios) para habilitar o provisionamento automático de usuários e grupos entre seu aplicativo e o Microsoft Entra ID. Este artigo descreve como criar um ponto de extremidade do SCIM e integrá-lo ao serviço de provisionamento do Microsoft Entra. A especificação do SCIM fornece um esquema de usuário comum para provisionamento. Quando usado com padrões de federação como SAML ou OpenID Connect, o SCIM fornece aos administradores uma solução de ponta a ponta baseada em padrões para o gerenciamento de acesso.

Provisionamento do Microsoft Entra ID para um aplicativo com SCIM

O SCIM 2.0 é uma definição padronizada de dois pontos de extremidade: um ponto de extremidade /Users e um ponto de extremidade /Groups. Ele usa pontos de extremidades da API REST comuns para criar, atualizar e excluir objetos. O SCIM consiste em um esquema predefinido para atributos comuns, como nome do grupo, nome de usuário, nome, sobrenome e email.

Os aplicativos que oferecem uma API REST do SCIM 2.0 podem reduzir ou eliminar o problema de trabalhar com uma API de gerenciamento de usuários proprietária. Por exemplo, qualquer cliente compatível com o SCIM saberá como fazer um HTTP POST de um objeto JSON para o ponto de extremidade /Users, a fim de criar uma nova entrada de usuário. Em vez de precisar de uma API um pouco diferente para as mesmas ações básicas, os aplicativos compatíveis com o padrão SCIM podem aproveitar instantaneamente os clientes, as ferramentas e o código preexistentes.

O esquema de objeto de usuário padrão e as APIs REST para gerenciamento definidos no SCIM 2.0 (RFC 7642, 7643, 7644) permitem que provedores de identidade e aplicativos sejam integrados com mais facilidade entre si. Os desenvolvedores de aplicativos que criam um ponto de extremidade SCIM podem se integrar a qualquer cliente compatível com SCIM sem precisar fazer personalizações.

Para automatizar o provisionamento em um aplicativo, será necessária a criação e integração de um ponto de extremidade do SCIM, acessado pelo serviço de provisionamento do Microsoft Entra. Use as etapas a seguir para iniciar o provisionamento de usuários e grupos em seu aplicativo.

  1. Crie seu esquema de usuário e grupo – Identifique os objetos e atributos do aplicativo para determinar como eles se adaptam ao esquema de usuário e grupo compatíveis com a implementação de SCIM do Microsoft Entra.

  2. Entenda a implementação de SCIM do Microsoft Entra – Entenda como o serviço de provisionamento do Microsoft Entra é implementado para modelar a administração e as respostas da solicitação de protocolo SCIM.

  3. Crie um ponto de extremidade do SCIM – Um ponto de extremidade deve ser compatível com o SCIM 2.0 para integração ao serviço de provisionamento do Microsoft Entra. Como opção, use as bibliotecas de CLI (Common Language Infrastructure) da Microsoft e os exemplos de código para criar o ponto de extremidade. Esses exemplos são apenas para referência e teste; não é recomendável usá-los como dependências no aplicativo de produção.

  4. Integre seu ponto de extremidade do SCIM ao Serviço de Provisionamento do Microsoft Entra. O Microsoft Entra ID é compatível com vários aplicativos de terceiros que implementam o SCIM 2.0. Se você usar um desses aplicativos, poderá automatizar rapidamente o provisionamento e o desprovisionamento de usuários e grupos.

  5. [Opcional] Publicar o aplicativo na galeria de aplicativos Microsoft Entra – Facilite a descoberta do aplicativo pelos clientes e configure facilmente o provisionamento.

Diagrama que mostra as etapas necessárias para integrar um ponto de extremidade SCIM com o Microsoft Entra ID.

Crie seu esquema de usuário e grupo

Cada aplicativo requer atributos diferentes para criar um usuário ou grupo. Inicie sua integração identificando os objetos necessários (usuários, grupos) e atributos (nome, gerente, cargo e assim por diante) de que seu aplicativo precisa.

O padrão SCIM define um esquema para gerenciar usuários e grupos.

O esquema de usuário principal requer apenas três atributos (todos os outros atributos são opcionais):

  • id, identificador definido pelo provedor de serviços
  • userName, um identificador exclusivo do usuário (geralmente, é direcionado para o nome da entidade de usuário do Microsoft Entra)
  • meta, metadados somente leitura mantidos pelo provedor de serviços

Além do esquema de usuário principal, o padrão SCIM define uma extensão de usuário corporativo com um modelo para estender o esquema do usuário para atender às necessidades do aplicativo.

Por exemplo: se o aplicativo exigir o email e o gerente de um usuário, use o esquema principal para coletar o email do usuário e o esquema corporativo para coletar o gerente do usuário.

Para criar o esquema, siga estas etapas:

  1. Liste os atributos necessários pelo aplicativo e, em seguida, categorize como atributos necessários para autenticação (por exemplo, loginName e email). Atributos são necessários para gerenciar o ciclo de vida do usuário (por exemplo, status/ativo) e todos os outros atributos necessários para que o aplicativo funcione (por exemplo, gerente, marca).

  2. Verifique se esses atributos já estão definidos no esquema de usuário principal ou no esquema de usuário corporativo. Caso contrário, você deverá definir uma extensão para o esquema de usuário que abranja os atributos ausentes. Confira o exemplo para ver uma extensão para o usuário a fim de permitir o provisionamento de um tag do usuário.

  3. Mapear os atributos SCIM para os atributos de usuário no Microsoft Entra ID. Se um dos atributos que você definiu no ponto de extremidade do SCIM não tiver um equivalente claro no esquema de usuário do Microsoft Entra, oriente o administrador de locatários a estender o esquema ou use um atributo de extensão, conforme mostrado no exemplo para a propriedade tags.

A tabela a seguir lista um exemplo dos atributos necessários:

Exemplo/atributo de aplicativo necessário Atributo SCIM mapeado Atributo do Microsoft Entra mapeado
loginName userName userPrincipalName
firstName name.givenName givenName
lastName name.familyName surName
workMail emails[type eq "work"].value Mail
manager manager manager
marcação urn:ietf:params:scim:schemas:extension:CustomExtensionName:2.0:User:tag extensionAttribute1
status active isSoftDeleted (valor calculado não armazenado no usuário)

A seguinte carga JSON mostra um esquema do SCIM de exemplo:

{
     "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User",
      "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
      "urn:ietf:params:scim:schemas:extension:CustomExtensionName:2.0:User"],
     "userName":"bjensen@testuser.com",
     "id": "48af03ac28ad4fb88478",
     "externalId":"bjensen",
     "name":{
       "familyName":"Jensen",
       "givenName":"Barbara"
     },
     "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
     "manager": "123456"
   },
     "urn:ietf:params:scim:schemas:extension:CustomExtensionName:2.0:User": {
     "tag": "701984",
   },
   "meta": {
     "resourceType": "User",
     "created": "2010-01-23T04:56:22Z",
     "lastModified": "2011-05-13T04:42:34Z",
     "version": "W\/\"3694e05e9dff591\"",
     "location":
 "https://example.com/v2/Users/00aa00aa-bb11-cc22-dd33-44ee44ee44ee"
   }
}

Observação

Além dos atributos necessários para o aplicativo, a declaração JSON também inclui os atributos id, externalId e meta obrigatórios.

Isso ajuda a categorizar entre /User e /Group para mapear os atributos de usuário padrão no Microsoft Entra ID para a RFC SCIM. Confira como os atributos personalizados são mapeados entre o Microsoft Entra ID e o ponto de extremidade do SCIM.

A tabela a seguir lista um exemplo de atributos de usuário:

Usuário do Microsoft Entra urn:ietf:params:scim:schemas:extension:enterprise:2.0:User
IsSoftDeleted active
department urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department
displayName displayName
employeeId urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber
Facsimile-TelephoneNumber phoneNumbers[type eq "fax"].value
givenName name.givenName
jobTitle title
mail emails[type eq "work"].value
mailNickname externalId
manager urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager
mobile phoneNumbers[type eq "mobile"].value
postalCode addresses[type eq "work"].postalCode
proxy-Addresses emails[type eq "other"].Value
physical-Delivery-OfficeName addresses[type eq "other"].Formatted
streetAddress addresses[type eq "work"].streetAddress
surname name.familyName
telephone-Number phoneNumbers[type eq "work"].value
user-PrincipalName userName

A tabela a seguir lista um exemplo de atributos de grupo:

Grupo do Microsoft Entra urn:ietf:params:scim:schemas:core:2.0:Group
displayName displayName
membros membros
objectId externalId

Observação

Você não precisa dar suporte a usuários e grupos, nem a todos os atributos mostrados aqui; esta é apenas uma referência de como os atributos no Microsoft Entra ID são quase sempre direcionados para as propriedades no protocolo SCIM.

Há vários pontos de extremidade definidos no RFC do SCIM. É possível começar com o ponto de extremidade /User e, em seguida, expandir com base nele. A tabela a seguir lista alguns dos pontos de extremidade do SCIM:

Ponto de extremidade Descrição
/User Executar operações CRUD em um objeto de usuário.
/Group Executar operações CRUD em um objeto de grupo.
/Schemas O conjunto de atributos com suporte de cada cliente e provedor de serviços pode variar. Um provedor de serviços poderá incluir name, title e emails, enquanto outro provedor de serviços usará name, title e phoneNumbers. O ponto de extremidade de esquemas permite a descoberta dos atributos compatíveis.
/Bulk As operações em lote permitem que você execute operações em uma grande coleção de objetos de recurso em uma única operação (por exemplo, atualizar associações para um grupo grande).
/ServiceProviderConfig Fornece detalhes sobre os recursos compatíveis do padrão do SCIM, por exemplo, os recursos que são compatíveis e o método de autenticação.
/ResourceTypes Especifica os metadados sobre cada recurso.

Observação

Use o ponto de extremidade /Schemas para dar suporte a atributos personalizados ou se o esquema for alterado com frequência, pois ele permite que um cliente recupere o esquema mais atualizado automaticamente. Usar o ponto de extremidade /Bulk para dar suporte a grupos.

Entender a implementação do SCIM pelo Microsoft Entra

O serviço de provisionamento do Microsoft Entra foi projetado para a compatibilidade com uma API de gerenciamento de usuários do SCIM 2.0.

Importante

O comportamento da implementação do SCIM do Microsoft Entra foi atualizado pela última vez em 18 de dezembro de 2018. Para obter informações sobre o que foi alterado, confira Conformidade do protocolo SCIM 2.0 do serviço de provisionamento de usuários do Microsoft Entra.

Dentro da especificação do protocolo SCIM 2.0, o aplicativo deve cumprir estes requisitos:

Requisito Notas de referência (protocolo SCIM)
Criar usuários e, opcionalmente, também criar grupos Seção 3.3
Modificar usuários ou grupos com solicitações de PATCH Seção 3.5.2. O suporte garantirá que grupos e usuários sejam provisionados para obter um desempenho adequado.
Recuperar um recurso conhecido para um usuário ou grupo criado anteriormente Seção 3.4.1
Consultar usuários ou grupos Seção 3.4.2. Por padrão, os usuários são recuperados com a id e consultados com username e externalId, e os grupos são consultados com displayName.
O filtro excludedAttributes=members quando o recurso do grupo for consultado Seção 3.4.2.2
Suporte à listagem de usuários e à paginação Seção 3.4.2.4.
Exclusão temporária de um usuário active=false e restauração do usuário active=true O objeto de usuário deverá ser retornado em uma solicitação, independente do usuário estar ativo ou não. A única vez em que o usuário não deverá ser retornado é quando ele for excluído do aplicativo de forma irreversível.
Suporte ao endpoint /Schemas Seção 7 O ponto de extremidade de descoberta do esquema é usado para descobrir mais atributos.
Aceitar um único token de portador para autenticação e autorização do Microsoft Entra ID para o aplicativo.

Use as diretrizes gerais quando implementar um ponto de extremidade de SCIM, a fim de garantir a compatibilidade com o Microsoft Entra ID:

Geral:

  • id é uma propriedade obrigatória para todos os recursos. Cada resposta que retorna um recurso deve garantir que cada recurso tenha essa propriedade, exceto para ListResponse com zero elementos.
  • Os valores enviados devem ser armazenados no mesmo formato em que foram enviados. Valores inválidos devem ser rejeitados com uma mensagem de erro descritiva e executável. As transformações de dados não devem ocorrer entre os dados do Microsoft Entra ID e os dados armazenados no aplicativo do SCIM. (por exemplo. Um número de telefone enviado como 55555555555 não deve ser salvo/retornado como + 5 (555) 555-5555)
  • Não é necessário incluir o recurso inteiro na resposta PATCH.
  • Não exija uma correspondência que diferencie maiúsculas de minúsculas em elementos estruturais no SCIM, principalmente os valores de operação op PATCH, conforme definido na seção 3.5.2. O Microsoft Entra ID emite os valores de op como Adicionar, Substituir e Remover.
  • O Microsoft Entra ID faz solicitações para buscar um usuário e um grupo aleatórios para garantir que o ponto de extremidade e as credenciais estão válidos. Também é feito como parte do fluxo Testar Conexão.
  • Suporte HTTPS no ponto de extremidade do SCIM.
  • Há suporte para atributos personalizados complexos e de múltiplos valores, mas o Microsoft Entra ID não possui muitas estruturas de dados complexas para extrair dados nesses casos. Os atributos de nome/valor podem ser mapeados facilmente, mas não há suporte para o fluxo de dados para atributos complexos com três ou mais subatributos.
  • Os valores de subatributo “type” de atributos complexos com multivalores precisam ser exclusivos. Por exemplo, não pode haver dois endereços de email diferentes com o subtipo “work”.
  • O cabeçalho de todas as respostas deve ser do seguinte tipo de conteúdo: application/scim+json

Recuperar recursos:

/Users:

  • O atributo de direitos não é compatível.
  • Todos os atributos considerados para exclusividade do usuário devem ser utilizáveis como parte de uma consulta filtrada. (por exemplo, se a exclusividade do usuário for avaliada para userName e emails[digite eq “work”], um GET para /Usuários com um filtro deverá permitir as consultas userName eq “user@contoso.com” e emails[type eq “work”].value eq “user@contoso.com”.

/Groups:

  • Os grupos são opcionais, mas só têm suporte se a implementação do SCIM for compatível com as solicitações PATCH.
  • Os grupos devem ter exclusividade no valor 'displayName' para corresponder ao Microsoft Entra ID e ao aplicativo SCIM. A singularidade não é um requisito do protocolo SCIM, mas é um requisito para integrar um ponto de extremidade do SCIM ao Microsoft Entra ID.

/Schemas (descoberta de esquema):

  • Solicitação/resposta de amostra
  • A descoberta de esquema está sendo usada em certos aplicativos da galeria. A descoberta de esquema é o único método para adicionar mais atributos ao esquema de um aplicativo SCIM de uma galeria existente. A descoberta de esquema não tem suporte atualmente no aplicativo SCIM personalizado fora da galeria.
  • Se um valor não estiver presente, não envie valores nulos.
  • Os valores da propriedade deverão ter uma concatenação com maiúsculas e minúsculas (por exemplo, readWrite).
  • Será necessário retornar uma resposta da lista.
  • O serviço de provisionamento do Microsoft Entra faz a solicitação /esquemas quando você salva a configuração de provisionamento. A solicitação também é feita quando você abre a página de provisionamento da edição. Outros atributos descobertos são exibidos para os clientes nos mapeamentos de atributo na lista de atributos de destino. A descoberta de esquema só leva à adição de mais atributos de destino. Os atributos não são removidos.

Provisionamento e desprovisionamento de usuários

O diagrama a seguir mostra as mensagens que o Microsoft Entra ID envia a um ponto de extremidade SCIM para gerenciar o ciclo de vida de um usuário no repositório de identidades do aplicativo.

Diagrama que mostra a sequência de desprovisionamento do usuário.

Provisionamento e desprovisionamento de grupos

O provisionamento e desprovisionamento de grupos são opcionais. Quando implementado e habilitado, a ilustração a seguir mostra as mensagens que o Microsoft Entra ID envia a um ponto de extremidade do SCIM para gerenciar o ciclo de vida de um grupo no repositório de identidades do aplicativo. Essas mensagens são diferentes das mensagens sobre os usuários em dois aspectos:

  • As solicitações para recuperar grupos especificam que o atributo de membros deve ser excluído de qualquer recurso fornecido em resposta à solicitação.
  • As solicitações para determinar se um atributo de referência tem um determinado valor são solicitações sobre o atributo dos membros.

O diagrama a seguir mostra a sequência de desprovisionamento do grupo:

Diagrama que mostra a sequência de desprovisionamento do grupo.

Solicitações e respostas do protocolo SCIM

Este artigo fornece solicitações SCIM de exemplo emitidas pelo serviço de provisionamento do Microsoft Entra e respostas esperadas de exemplo. Para obter melhores resultados, você deve codificar o aplicativo para lidar com essas solicitações nesse formato e emitir as respostas esperadas.

Importante

Para entender como e quando o serviço de provisionamento de usuários do Microsoft Entra emite as operações descritas no exemplo, confira a seção Ciclos de provisionamento: inicial e incremental em Como funciona o provisionamento.

Operações do Usuário

Operações de Grupo

Descoberta de esquema

Operações do Usuário

  • Use os atributos userName ou emails[type eq "work"] para consultar usuários.

Criar usuário

Solicitação

POST /Usuários

{
    "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User",
        "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],
    "externalId": "0a21f0f2-8d2a-4f8e-bf98-7363c4aed4ef",
    "userName": "Test_User_00aa00aa-bb11-cc22-dd33-44ee44ee44ee",
    "active": true,
    "emails": [{
        "primary": true,
        "type": "work",
        "value": "Test_User_11bb11bb-cc22-dd33-ee44-55ff55ff55ff@testuser.com"
    }],
    "meta": {
        "resourceType": "User"
    },
    "name": {
        "formatted": "givenName familyName",
        "familyName": "familyName",
        "givenName": "givenName"
    },
    "roles": []
}
Resposta

Criado em HTTP/1.1 201

{
    "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
    "id": "48af03ac28ad4fb88478",
    "externalId": "0a21f0f2-8d2a-4f8e-bf98-7363c4aed4ef",
    "meta": {
        "resourceType": "User",
        "created": "2018-03-27T19:59:26.000Z",
        "lastModified": "2018-03-27T19:59:26.000Z"
    },
    "userName": "Test_User_00aa00aa-bb11-cc22-dd33-44ee44ee44ee",
    "name": {
        "formatted": "givenName familyName",
        "familyName": "familyName",
        "givenName": "givenName",
    },
    "active": true,
    "emails": [{
        "value": "Test_User_11bb11bb-cc22-dd33-ee44-55ff55ff55ff@testuser.com",
        "type": "work",
        "primary": true
    }]
}

Obter Usuário

Solicitar

GET /Users/5d48a0a8e9f04aa38008

Resposta (Usuário encontrado)

HTTP/1.1 200 OK

{
    "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
    "id": "5d48a0a8e9f04aa38008",
    "externalId": "58342554-38d6-4ec8-948c-50044d0a33fd",
    "meta": {
        "resourceType": "User",
        "created": "2018-03-27T19:59:26.000Z",
        "lastModified": "2018-03-27T19:59:26.000Z"
    },
    "userName": "Test_User_00aa00aa-bb11-cc22-dd33-44ee44ee44ee",
    "name": {
        "formatted": "givenName familyName",
        "familyName": "familyName",
        "givenName": "givenName",
    },
    "active": true,
    "emails": [{
        "value": "Test_User_11bb11bb-cc22-dd33-ee44-55ff55ff55ff@testuser.com",
        "type": "work",
        "primary": true
    }]
}
Solicitar

GET /Users/5171a35d82074e068ce2

Resposta (Usuário não encontrado. O detalhe não é obrigatório, apenas o status.)

HTTP/1.1 404 Não Encontrado

{
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:Error"
    ],
    "status": "404",
    "detail": "Resource 23B51B0E5D7AE9110A49411D@7cca31655d49f3640a494224 not found"
}

Obter Usuário por consulta

Solicitar

GET /Users?filter=userName eq "Test_User_00aa00aa-bb11-cc22-dd33-44ee44ee44ee"

Resposta

HTTP/1.1 200 OK

{
    "schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],
    "totalResults": 1,
    "Resources": [{
        "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
        "id": "2441309d85324e7793ae",
        "externalId": "7fce0092-d52e-4f76-b727-3955bd72c939",
        "meta": {
            "resourceType": "User",
            "created": "2018-03-27T19:59:26.000Z",
            "lastModified": "2018-03-27T19:59:26.000Z"
            
        },
        "userName": "Test_User_00aa00aa-bb11-cc22-dd33-44ee44ee44ee",
        "name": {
            "familyName": "familyName",
            "givenName": "givenName"
        },
        "active": true,
        "emails": [{
            "value": "Test_User_11bb11bb-cc22-dd33-ee44-55ff55ff55ff@testuser.com",
            "type": "work",
            "primary": true
        }]
    }],
    "startIndex": 1,
    "itemsPerPage": 20
}

Obter Usuário por consulta - Zero resultados

Solicitar

GET /Users?filter=userName eq "non-existent user"

Resposta

HTTP/1.1 200 OK

{
    "schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],
    "totalResults": 0,
    "Resources": [],
    "startIndex": 1,
    "itemsPerPage": 20
}

Atualizar Usuário [Propriedades com vários valores]

Solicitar

PATCH /Users/6764549bef60420686bc HTTP/1.1

{
    "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
    "Operations": [
            {
            "op": "Replace",
            "path": "emails[type eq \"work\"].value",
            "value": "updatedEmail@microsoft.com"
            },
            {
            "op": "Replace",
            "path": "name.familyName",
            "value": "updatedFamilyName"
            }
    ]
}
Resposta

HTTP/1.1 200 OK

{
    "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
    "id": "6764549bef60420686bc",
    "externalId": "6c75de36-30fa-4d2d-a196-6bdcdb6b6539",
    "meta": {
        "resourceType": "User",
        "created": "2018-03-27T19:59:26.000Z",
        "lastModified": "2018-03-27T19:59:26.000Z"
    },
    "userName": "Test_User_00aa00aa-bb11-cc22-dd33-44ee44ee44ee",
    "name": {
        "formatted": "givenName updatedFamilyName",
        "familyName": "updatedFamilyName",
        "givenName": "givenName"
    },
    "active": true,
    "emails": [{
        "value": "updatedEmail@microsoft.com",
        "type": "work",
        "primary": true
    }]
}

Atualizar Usuário [Propriedades de valor único]

Solicitar

PATCH /Users/5171a35d82074e068ce2 HTTP/1.1

{
    "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
    "Operations": [{
        "op": "Replace",
        "path": "userName",
        "value": "5b50642d-79fc-4410-9e90-4c077cdd1a59@testuser.com"
    }]
}
Resposta

HTTP/1.1 200 OK

{
    "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
    "id": "5171a35d82074e068ce2",
    "externalId": "aa1eca08-7179-4eeb-a0be-a519f7e5cd1a",
    "meta": {
        "resourceType": "User",
        "created": "2018-03-27T19:59:26.000Z",
        "lastModified": "2018-03-27T19:59:26.000Z"
        
    },
    "userName": "5b50642d-79fc-4410-9e90-4c077cdd1a59@testuser.com",
    "name": {
        "formatted": "givenName familyName",
        "familyName": "familyName",
        "givenName": "givenName",
    },
    "active": true,
    "emails": [{
        "value": "Test_User_11bb11bb-cc22-dd33-ee44-55ff55ff55ff@testuser.com",
        "type": "work",
        "primary": true
    }]
}

Desabilitar Usuário

Solicitar

PATCH /Users/5171a35d82074e068ce2 HTTP/1.1

{
    "Operations": [
        {
            "op": "Replace",
            "path": "active",
            "value": false
        }
    ],
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:PatchOp"
    ]
}
Resposta
{
    "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User"
    ],
    "id": "CEC50F275D83C4530A495FCF@834d0e1e5d8235f90a495fda",
    "userName": "deanruiz@testuser.com",
    "name": {
        "familyName": "Harris",
        "givenName": "Larry"
    },
    "active": false,
    "emails": [
        {
            "value": "gloversuzanne@testuser.com",
            "type": "work",
            "primary": true
        }
    ],
    "addresses": [
        {
            "country": "ML",
            "type": "work",
            "primary": true
        }
    ],
    "meta": {
        "resourceType": "Users",
        "location": "/scim/5171a35d82074e068ce2/Users/CEC50F265D83B4530B495FCF@5171a35d82074e068ce2"
    }
}

Excluir usuário

Solicitar

DELETE /Users/5171a35d82074e068ce2 HTTP/1.1

Resposta

HTTP/1.1 204 Sem Conteúdo

Operações de Grupo

  • Os grupos são criados com uma lista de membros vazios.
  • Use o atributo displayName para consultar grupos.
  • A solicitação PATCH para atualizar para o grupo deve exibir HTTP 204 Sem Conteúdo na resposta. Retornar um corpo com uma lista de todos os membros não é aconselhável.
  • Não é necessário dar suporte ao retorno de todos os membros do grupo.

Criar Grupo

Solicitar

POST /Grupos HTTP/1.1

{
    "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group", "http://schemas.microsoft.com/2006/11/ResourceManagement/ADSCIM/2.0/Group"],
    "externalId": "8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159",
    "displayName": "displayName",
    "meta": {
        "resourceType": "Group"
    }
}
Resposta

Criado em HTTP/1.1 201

{
    "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"],
    "id": "927fa2c08dcb4a7fae9e",
    "externalId": "8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159",
    "meta": {
        "resourceType": "Group",
        "created": "2018-03-27T19:59:26.000Z",
        "lastModified": "2018-03-27T19:59:26.000Z"
        
    },
    "displayName": "displayName",
    "members": []
}

Obter Grupo

Solicitar

GET /Groups/40734ae655284ad3abcc?excludedAttributes=members HTTP/1.1

Resposta

HTTP/1.1 200 OK

{
    "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"],
    "id": "40734ae655284ad3abcc",
    "externalId": "60f1bb27-2e1e-402d-bcc4-ec999564a194",
    "meta": {
        "resourceType": "Group",
        "created": "2018-03-27T19:59:26.000Z",
        "lastModified": "2018-03-27T19:59:26.000Z"
    },
    "displayName": "displayName",
}

Obter Grupo por displayName

Solicitar

GET /Groups?excludedAttributes=members&filter=displayName eq "displayName" HTTP/1.1

Resposta

HTTP/1.1 200 OK

{
    "schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],
    "totalResults": 1,
    "Resources": [{
        "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"],
        "id": "8c601452cc934a9ebef9",
        "externalId": "0db508eb-91e2-46e4-809c-30dcbda0c685",
        "meta": {
            "resourceType": "Group",
            "created": "2018-03-27T22:02:32.000Z",
            "lastModified": "2018-03-27T22:02:32.000Z",
            
        },
        "displayName": "displayName",
    }],
    "startIndex": 1,
    "itemsPerPage": 20
}

Atualizar Grupo [Atributos de não membro]

Solicitar

PATCH /Groups/fa2ce26709934589afc5 HTTP/1.1

{
    "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
    "Operations": [{
        "op": "Replace",
        "path": "displayName",
        "value": "1879db59-3bdf-4490-ad68-ab880a269474updatedDisplayName"
    }]
}
Resposta

HTTP/1.1 204 Sem Conteúdo

Atualizar Grupo [Adicionar Membros]

Solicitar

PATCH /Groups/a99962b9f99d4c4fac67 HTTP/1.1

{
    "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
    "Operations": [{
        "op": "Add",
        "path": "members",
        "value": [{
            "$ref": null,
            "value": "f648f8d5ea4e4cd38e9c"
        }]
    }]
}
Resposta

HTTP/1.1 204 Sem Conteúdo

Atualizar Grupo [Remover Membros]

Solicitar

PATCH /Groups/a99962b9f99d4c4fac67 HTTP/1.1

{
    "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
    "Operations": [{
        "op": "Remove",
        "path": "members",
        "value": [{
            "$ref": null,
            "value": "f648f8d5ea4e4cd38e9c"
        }]
    }]
}
Resposta

HTTP/1.1 204 Sem Conteúdo

Excluir grupo

Solicitar

DELETE /Groups/cdb1ce18f65944079d37 HTTP/1.1

Resposta

HTTP/1.1 204 Sem Conteúdo

Descoberta de esquema

Descobrir esquema

Solicitar

GET /Schemas

Resposta

HTTP/1.1 200 OK

{
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:ListResponse"
    ],
    "itemsPerPage": 50,
    "startIndex": 1,
    "totalResults": 3,
    "Resources": [
  {
    "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Schema"],
    "id" : "urn:ietf:params:scim:schemas:core:2.0:User",
    "name" : "User",
    "description" : "User Account",
    "attributes" : [
      {
        "name" : "userName",
        "type" : "string",
        "multiValued" : false,
        "description" : "Unique identifier for the User, typically
used by the user to directly authenticate to the service provider.
Each User MUST include a non-empty userName value.  This identifier
MUST be unique across the service provider's entire set of Users.
REQUIRED.",
        "required" : true,
        "caseExact" : false,
        "mutability" : "readWrite",
        "returned" : "default",
        "uniqueness" : "server"
      },                
    ],
    "meta" : {
      "resourceType" : "Schema",
      "location" :
        "/v2/Schemas/urn:ietf:params:scim:schemas:core:2.0:User"
    }
  },
  {
    "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Schema"],
    "id" : "urn:ietf:params:scim:schemas:core:2.0:Group",
    "name" : "Group",
    "description" : "Group",
    "attributes" : [
      {
        "name" : "displayName",
        "type" : "string",
        "multiValued" : false,
        "description" : "A human-readable name for the Group.
REQUIRED.",
        "required" : false,
        "caseExact" : false,
        "mutability" : "readWrite",
        "returned" : "default",
        "uniqueness" : "none"
      },
    ],
    "meta" : {
      "resourceType" : "Schema",
      "location" :
        "/v2/Schemas/urn:ietf:params:scim:schemas:core:2.0:Group"
    }
  },
  {
    "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Schema"],
    "id" : "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
    "name" : "EnterpriseUser",
    "description" : "Enterprise User",
    "attributes" : [
      {
        "name" : "employeeNumber",
        "type" : "string",
        "multiValued" : false,
        "description" : "Numeric or alphanumeric identifier assigned
to a person, typically based on order of hire or association with an
organization.",
        "required" : false,
        "caseExact" : false,
        "mutability" : "readWrite",
        "returned" : "default",
        "uniqueness" : "none"
      },
    ],
    "meta" : {
      "resourceType" : "Schema",
      "location" :
"/v2/Schemas/urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
    }
  }
]
}

Requisitos de segurança

Versões do Protocolo TLS

A única versão de protocolo aceitável é o TLS 1.2. Nenhuma outra versão do SSL/TLS é permitida.

  • As chaves RSA devem ter pelo menos 2.048 bits.
  • As chaves ECC devem ter pelo menos 256 bits, geradas usando uma curva elíptica aprovada

Tamanhos das Chaves

Todos os serviços devem usar certificados X.509 gerados pelo uso das chaves de criptografia de duração suficiente, o que significa que:

Conjuntos de Criptografia

Todos os serviços precisam ser configurados para usar os conjuntos de criptografia a seguir, na ordem exata especificada no exemplo. Se você tiver apenas um certificado RSA, os conjuntos de criptografia ECDSA não terão nenhum efeito.

Barramento mínimo dos conjuntos de criptografia TLS 1.2:

  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384

Intervalos de IP

O serviço de provisionamento Microsoft Entra opera atualmente nos Intervalos de IP para o Microsoft Entra ID, conforme listado aqui. É possível adicionar os intervalos de IP listados na tag AzureActiveDirectory para permitir o tráfego do serviço de provisionamento do Microsoft Entra no aplicativo. Será necessário examinar com atenção a lista de intervalos de IP com os endereços computados. Um endereço como '40.126.25.32' poderá ser representado na lista de intervalos de IP como '40.126.0.0/18'. Também é possível recuperar de modo programático a lista de intervalos de IP usando a API a seguir.

O Microsoft Entra ID também é compatível com uma solução baseada no agente para fornecer conectividade a aplicativos em redes privadas (locais, hospedadas no Azure, hospedadas no AWS etc.). Os clientes podem implantar um agente leve, que fornece conectividade ao Microsoft Entra ID sem abrir nenhuma porta de entrada, em um servidor na rede privada. Saiba mais aqui.

Crie um ponto de extremidade do SCIM

Agora que você criou seu esquema e entendeu a implementação do SCIM do Microsoft Entra, comece a desenvolver seu ponto de extremidade do SCIM. Em vez de começar do zero e criar a implementação completamente por conta própria, você pode contar com várias bibliotecas de SCIM de software livre publicadas pela Comunidade do SCIM.

Para obter diretrizes sobre como criar um ponto de extremidade SCIM, incluindo exemplos, confira Desenvolver um ponto de extremidade SCIM de exemplo.

O exemplo de código de referência do .NET Core de software livre publicado pela equipe de provisionamento do Microsoft Entra é um recurso que pode impulsionar seu desenvolvimento. Crie um ponto de extremidade SCIM e teste-o executando as solicitações/respostas de exemplo fornecidas.

Observação

O código de referência destina-se a ajudar você a começar a criar o ponto de extremidade SCIM, e é fornecido "no estado em que se encontra". As contribuições da comunidade são bem-vindas e ajudam a criar e manter o código.

A solução é composta por dois projetos, Microsoft.SCIM e Microsoft.SCIM.WebHostSample.

O projeto Microsoft.SCIM é a biblioteca que define os componentes do serviço Web, conforme a especificação SCIM. Ele declara a interface Microsoft.SCIM.IProvider, as solicitações são convertidas em chamadas para os métodos do provedor, que seriam programados para operar em um repositório de identidades.

Detalhamento: uma solicitação convertida em chamadas para os métodos do provedor

O projeto Microsoft.SCIM.WebHostSample é um aplicativo Web do ASP.NET Core, com base no modelo Empty. Ele permite que o código de exemplo seja implantado como autônomo, hospedado em contêineres ou dentro de Serviços de Informações da Internet. Ele também implementa a interface Microsoft.SCIM.IProvider mantendo classes na memória como um repositório de identidade de exemplo.

public class Startup
{
    ...
    public IMonitor MonitoringBehavior { get; set; }
    public IProvider ProviderBehavior { get; set; }

    public Startup(IWebHostEnvironment env, IConfiguration configuration)
    {
        ...
        this.MonitoringBehavior = new ConsoleMonitor();
        this.ProviderBehavior = new InMemoryProvider();
    }
    ...

Criando um ponto de extremidade SCIM personalizado

O ponto de extremidade do SCIM deve ter um endereço HTTP e um certificado de autenticação de servidor do qual a autoridade de certificação raiz é dos seguintes nomes:

  • CNNIC
  • Comodo
  • CyberTrust
  • DigiCert
  • GeoTrust
  • GlobalSign
  • Go Daddy
  • VeriSign
  • WoSign
  • DST Raiz CA X3

O SDK do .NET Core inclui um certificado de desenvolvimento HTTPS usado durante o desenvolvimento. O certificado é instalado como parte da experiência da primeira execução. Dependendo de como você executa o Aplicativo Web ASP.NET Core, ele escuta em uma porta diferente:

  • Microsoft.SCIM.WebHostSample: https://localhost:5001
  • IIS Express: https://localhost:44359

Para saber mais sobre HTTPS no ASP.NET Core, use o seguinte link: Impor HTTPS no ASP.NET Core

Administrar a autenticação do ponto de extremidade

As solicitações do serviço de provisionamento do Microsoft Entra incluem um token de portador do OAuth 2.0. Um servidor de autorização emite o token de portador. O Microsoft Entra ID é um exemplo de um servidor de autorização confiável. Configurar o serviço de provisionamento do Microsoft Entra para usar um dos seguintes tokens:

  • Um token de portador de longa duração. Se o ponto de extremidade SCIM exigir um token de portador OAuth de um emissor diferente do Microsoft Entra ID, copie o token de portador OAuth necessário para o campo opcional Token Secreto. Em um ambiente de desenvolvimento, você pode usar o token de teste do ponto de extremidade /scim/token. Os tokens de teste não devem ser usados em ambientes de produção.

  • Token de portador do Microsoft Entra. Se o campo Token Secreto estiver em branco, o Microsoft Entra ID inclui um token de portador OAuth emitido do Microsoft Entra ID com cada solicitação. Os aplicativos que usam o Microsoft Entra ID como provedor de identidade podem validar esse token emitido pelo Microsoft Entra ID.

    • O aplicativo que recebe solicitações deve validar o emissor do token como sendo Microsoft Entra ID para um locatário do Microsoft Entra esperado.
    • Uma declaração iss identifica o emissor do token. Por exemplo, "iss":"https://sts.windows.net/aaaabbbb-0000-cccc-1111-dddd2222eeee/". Neste exemplo, o endereço base do valor da declaração, https://sts.windows.net identifica o Microsoft Entra ID como emissor, enquanto o segmento de endereço relativo, aaaabbbb-0000-cccc-1111-dddd2222eeee, é um identificador exclusivo do locatário do Microsoft Entra para o qual o token foi emitido.
    • O público-alvo de um token é a ID do aplicativo para o aplicativo na galeria. Os aplicativos registrados em um único locatário recebem a mesma declaração iss com solicitações SCIM. A ID do aplicativo para todos os aplicativos personalizados é 8adf8e6e-67b2-4cf2-a259-e3dc5476c621. O token gerado pelo Microsoft Entra ID só deve ser usado para teste. Ele não deve ser usado em ambientes de produção.

No código de exemplo, as solicitações são autenticadas usando o pacote Microsoft.AspNetCore.Authentication.JwtBearer. O código a seguir impõe que as solicitações para qualquer um dos pontos de extremidade do serviço sejam autenticadas usando o token de portador emitido pelo Microsoft Entra ID para um locatário especificado:

public void ConfigureServices(IServiceCollection services)
{
    if (_env.IsDevelopment())
    {
        ...
    }
    else
    {
        services.AddAuthentication(options =>
        {
            options.DefaultAuthenticateScheme = JwtBearerDefaults.AuthenticationScheme;
            options.DefaultChallengeScheme = JwtBearerDefaults.AuthenticationScheme;
        })
            .AddJwtBearer(options =>
            {
                options.Authority = " https://sts.windows.net/aaaabbbb-0000-cccc-1111-dddd2222eeee/";
                options.Audience = "8adf8e6e-67b2-4cf2-a259-e3dc5476c621";
                ...
            });
    }
    ...
}

public void Configure(IApplicationBuilder app)
{
    ...
    app.UseAuthentication();
    app.UseAuthorization();
    ...
}

O código de exemplo usa ambientes ASP.NET Core para alterar as opções de autenticação durante o estágio de desenvolvimento e habilitar o uso de um token autoassinado.

Para obter mais informações sobre vários ambientes no ASP.NET Core, confira Usar vários ambientes no ASP.NET Core.

O código a seguir impõe que as solicitações para qualquer um dos pontos de extremidade do serviço sejam autenticadas usando um token de portador assinado com uma chave personalizada:

public void ConfigureServices(IServiceCollection services)
{
    if (_env.IsDevelopment())
    {
        services.AddAuthentication(options =>
        {
            options.DefaultAuthenticateScheme = JwtBearerDefaults.AuthenticationScheme;
            options.DefaultChallengeScheme = JwtBearerDefaults.AuthenticationScheme;
        })
        .AddJwtBearer(options =>
        {
            options.TokenValidationParameters =
                new TokenValidationParameters
                {
                    ValidateIssuer = false,
                    ValidateAudience = false,
                    ValidateLifetime = false,
                    ValidateIssuerSigningKey = false,
                    ValidIssuer = "Microsoft.Security.Bearer",
                    ValidAudience = "Microsoft.Security.Bearer",
                    IssuerSigningKey = new SymmetricSecurityKey(Encoding.UTF8.GetBytes("A1B2C3D4E5F6A1B2C3D4E5F6"))
                };
        });
    }
...

Enviar uma solicitação GET ao controlador de token para obter um token de portador válido. O método GenerateJSONWebToken é responsável por criar um token que corresponda aos parâmetros configurados para desenvolvimento:

private string GenerateJSONWebToken()
{
    // Create token key
    SymmetricSecurityKey securityKey =
        new SymmetricSecurityKey(Encoding.UTF8.GetBytes("A1B2C3D4E5F6A1B2C3D4E5F6"));
    SigningCredentials credentials =
        new SigningCredentials(securityKey, SecurityAlgorithms.HmacSha256);

    // Set token expiration
    DateTime startTime = DateTime.UtcNow;
    DateTime expiryTime = startTime.AddMinutes(120);

    // Generate the token
    JwtSecurityToken token =
        new JwtSecurityToken(
            "Microsoft.Security.Bearer",
            "Microsoft.Security.Bearer",
            null,
            notBefore: startTime,
            expires: expiryTime,
            signingCredentials: credentials);

    string result = new JwtSecurityTokenHandler().WriteToken(token);
    return result;
}

Administrar o provisionamento e o desprovisionamento de usuários

Exemplo 1. Confira o serviço para obter um usuário correspondente

O Microsoft Entra ID consulta o serviço para encontrar um usuário com um valor de atributo externalId correspondente ao valor de atributo mailNickname de um usuário no Microsoft Entra ID. A consulta é expressa como solicitação de Protocolo HTTP, como nesse exemplo, na qual jyoung é uma amostra de um mailNickname de um usuário no Microsoft Entra ID.

Observação

Este é apenas um exemplo. Nem todos os usuários terão um atributo mailNickname, e o valor que um usuário tem pode não ser exclusivo no diretório. Além disso, o atributo usado para correspondência (que nesse caso é externalId) será configurável nos mapeamentos de atributos do Microsoft Entra.

GET https://.../scim/Users?filter=externalId eq jyoung HTTP/1.1
 Authorization: Bearer ...

No código de exemplo, a solicitação é convertida em uma chamada para o método QueryAsync do provedor do serviço. Veja a assinatura desse método:

// System.Threading.Tasks.Tasks is defined in mscorlib.dll.  
// Microsoft.SCIM.IRequest is defined in 
// Microsoft.SCIM.Service.  
// Microsoft.SCIM.Resource is defined in 
// Microsoft.SCIM.Schemas.  
// Microsoft.SCIM.IQueryParameters is defined in 
// Microsoft.SCIM.Protocol.  

Task<Resource[]> QueryAsync(IRequest<IQueryParameters> request);

Na consulta de exemplo, para um usuário com um valor fornecido para o atributo externalId, os valores dos argumentos passados para o método QueryAsync serão:

  • parameters.AlternateFilters.Count: 1
  • parameters.AlternateFilters.ElementAt(0).AttributePath: "externalId"
  • parameters.AlternateFilters.ElementAt(0).ComparisonOperator: ComparisonOperator.Equals
  • parameters.AlternateFilter.ElementAt(0).ComparisonValue: "jyoung"

Exemplo 2. Provisione um usuário

Caso a resposta a uma consulta ao ponto de extremidade do SCIM para um usuário com um valor de atributo externalId que corresponde ao valor de atributo mailNickname de um usuário não retorne nenhum usuário, o Microsoft Entra ID solicitará que o serviço provisione um usuário correspondente ao usuário no Microsoft Entra ID. Veja um exemplo dessa solicitação:

POST https://.../scim/Users HTTP/1.1
Authorization: Bearer ...
Content-type: application/scim+json
{
   "schemas":
   [
     "urn:ietf:params:scim:schemas:core:2.0:User",
     "urn:ietf:params:scim:schemas:extension:enterprise:2.0User"],
   "externalId":"jyoung",
   "userName":"jyoung@testuser.com",
   "active":true,
   "addresses":null,
   "displayName":"Joy Young",
   "emails": [
     {
       "type":"work",
       "value":"jyoung@Contoso.com",
       "primary":true}],
   "meta": {
     "resourceType":"User"},
    "name":{
     "familyName":"Young",
     "givenName":"Joy"},
   "phoneNumbers":null,
   "preferredLanguage":null,
   "title":null,
   "department":null,
   "manager":null}

No código de exemplo, a solicitação é convertida em uma chamada para o método CreateAsync do provedor do serviço. Veja a assinatura desse método:

// System.Threading.Tasks.Tasks is defined in mscorlib.dll.  
// Microsoft.SCIM.IRequest is defined in 
// Microsoft.SCIM.Service.  
// Microsoft.SCIM.Resource is defined in 
// Microsoft.SCIM.Schemas.  

Task<Resource> CreateAsync(IRequest<Resource> request);

Em uma solicitação para um provisionamento de usuário, o valor do argumento do recurso é uma instância da classe Microsoft.SCIM.Core2EnterpriseUser. Essa classe é definida na biblioteca Microsoft.SCIM.Schemas. Se a solicitação de provisionamento do usuário for bem-sucedida, a implementação do método deverá retornar uma instância da classe Microsoft.SCIM.Core2EnterpriseUser. O valor da propriedade Identifier é definido como o identificador exclusivo do usuário recém-provisionado.

Exemplo 3. Confira o estado atual de um usuário

O Microsoft Entra ID solicita o estado atual do usuário especificado no serviço, com uma solicitação como:

GET ~/scim/Users/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1 HTTP/1.1
Authorization: Bearer ...

No código de exemplo, a solicitação é convertida em uma chamada para o método RetrieveAsync do provedor do serviço. Veja a assinatura desse método:

// System.Threading.Tasks.Tasks is defined in mscorlib.dll.  
// Microsoft.SCIM.IRequest is defined in 
// Microsoft.SCIM.Service.  
// Microsoft.SCIM.Resource and 
// Microsoft.SCIM.IResourceRetrievalParameters 
// are defined in Microsoft.SCIM.Schemas 

Task<Resource> RetrieveAsync(IRequest<IResourceRetrievalParameters> request);

No exemplo de uma solicitação para recuperar o estado atual de um usuário, os valores das propriedades do objeto fornecidos como o valor do argumento de parâmetros são:

  • Identificador: "a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1"
  • SchemaIdentifier: urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

Exemplo 4. Consulte o valor de um atributo de referência a ser atualizado

O Microsoft Entra ID verifica o valor do atributo atual no repositório de identidade antes de atualizá-lo. No entanto, somente o atributo de gerente é verificado primeiro para usuários. Veja o exemplo de uma solicitação para determinar se o atributo de gerenciador de um objeto de usuário atualmente tem um determinado valor: no código de exemplo, a solicitação é convertida em uma chamada para o método QueryAsync do provedor do serviço. O valor das propriedades do objeto fornecido como o valor do argumento de parâmetros é o seguinte:

  • parameters.AlternateFilters.Count: 2
  • parameters.AlternateFilters.ElementAt(x).AttributePath: "ID"
  • parameters.AlternateFilters.ElementAt(x).ComparisonOperator: ComparisonOperator.Equals
  • parameters.AlternateFilter.ElementAt(x).ComparisonValue: "a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1"
  • parameters.AlternateFilters.ElementAt(y).AttributePath: "manager"
  • parameters.AlternateFilters.ElementAt(y).ComparisonOperator: ComparisonOperator.Equals
  • parameters.AlternateFilter.ElementAt(y).ComparisonValue: "00aa00aa-bb11-cc22-dd33-44ee44ee44ee"
  • parameters.RequestedAttributePaths.ElementAt(0): "ID"
  • parameters.SchemaIdentifier: urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

O valor do índice x pode ser 0 e o valor do índice y pode ser 1. Ou o valor de x pode ser 1 e o valor de y pode ser 0. Depende da ordem das expressões do parâmetro de consulta de filtro.

Exemplo 5. Solicitação a atualização de um usuário, do Microsoft Entra ID para um ponto de extremidade do SCIM

Aqui está um exemplo de uma solicitação do Microsoft Entra ID para um ponto de extremidade do SCIM, que visa atualizar um usuário:

PATCH ~/scim/Users/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1 HTTP/1.1
Authorization: Bearer ...
Content-type: application/scim+json
{
    "schemas": 
    [
      "urn:ietf:params:scim:api:messages:2.0:PatchOp"],
    "Operations":
    [
      {
        "op":"Add",
        "path":"manager",
        "value":
          [
            {
              "$ref":"http://.../scim/Users/00aa00aa-bb11-cc22-dd33-44ee44ee44ee",
              "value":"00aa00aa-bb11-cc22-dd33-44ee44ee44ee"}]}]}

No código de exemplo, a solicitação é convertida em uma chamada para o método UpdateAsync do provedor do serviço. Veja a assinatura desse método:

// System.Threading.Tasks.Tasks and 
// System.Collections.Generic.IReadOnlyCollection<T>  // are defined in mscorlib.dll.  
// Microsoft.SCIM.IRequest is defined in
// Microsoft.SCIM.Service.
// Microsoft.SCIM.IPatch, 
// is defined in Microsoft.SCIM.Protocol. 

Task UpdateAsync(IRequest<IPatch> request);

No exemplo de uma solicitação, para atualizar um usuário, o objeto fornecido como valor do argumento de patch tem estes valores de propriedade:

Argumento Valor
ResourceIdentifier.Identifier "a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1"
ResourceIdentifier.SchemaIdentifier urn:ietf:params:scim:schemas:extension:enterprise:2.0:User
(PatchRequest as PatchRequest2).Operations.Count 1
(PatchRequest as PatchRequest2).Operations.ElementAt(0).OperationName OperationName.Add
(PatchRequest as PatchRequest2).Operations.ElementAt(0).Path.AttributePath Manager
(PatchRequest as PatchRequest2).Operations.ElementAt(0).Value.Count 1
(PatchRequest as PatchRequest2).Operations.ElementAt(0).Value.ElementAt(0).Reference http://.../scim/Users/00aa00aa-bb11-cc22-dd33-44ee44ee44ee
(PatchRequest as PatchRequest2).Operations.ElementAt(0).Value.ElementAt(0).Value 00aa00aa-bb11-cc22-dd33-44ee44ee44ee

Exemplo 6. Desprovisione um usuário

Para desprovisionar um usuário de um repositório de identidades administrado por um ponto de extremidade do SCIM, o Microsoft Entra ID envia uma solicitação como esta:

DELETE ~/scim/Users/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1 HTTP/1.1
Authorization: Bearer ...

No código de exemplo, a solicitação é convertida em uma chamada para o método DeleteAsync do provedor do serviço. Veja a assinatura desse método:

// System.Threading.Tasks.Tasks is defined in mscorlib.dll.  
// Microsoft.SCIM.IRequest is defined in 
// Microsoft.SCIM.Service.  
// Microsoft.SCIM.IResourceIdentifier, 
// is defined in Microsoft.SCIM.Protocol. 

Task DeleteAsync(IRequest<IResourceIdentifier> request);

O objeto fornecido como valor do argumento resourceIdentifier tem estes valores de propriedade no exemplo de uma solicitação para desprovisionar um usuário:

  • ResourceIdentifier.Identifier: "a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1"
  • ResourceIdentifier.SchemaIdentifier: urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

Integre seu ponto de extremidade do SCIM ao Serviço de Provisionamento do Microsoft Entra

O Microsoft Entra ID pode ser configurado para provisionar automaticamente usuários e grupos atribuídos a aplicativos que implementam um perfil específico do protocolo SCIM 2.0. As especificidades do perfil estão documentadas em Entender a implementação do SCIM do Microsoft Entra.

Verifique com o seu provedor de aplicativo, ou na documentação dele, as instruções de compatibilidade com esses requisitos.

Importante

A implementação do SCIM do Microsoft Entra é criada sobre o serviço de provisionamento de usuários do Microsoft Entra, projetado para manter constantemente os usuários sincronizados entre o Microsoft Entra ID e o aplicativo de destino, e implementa um conjunto muito específico de operações padrão. É importante entender esses comportamentos para entender o comportamento do serviço de provisionamento do Microsoft Entra. Para saber mais, confira a seção Ciclos de provisionamento: inicial e incremental em Como funciona o provisionamento.

Introdução

Dica

As etapas neste artigo podem variar ligeiramente com base no portal do qual você começa.

Os aplicativos compatíveis com o perfil do SCIM, descritos neste artigo, podem ser conectados ao Microsoft Entra ID usando o recurso de aplicativo fora da galeria na galeria de aplicativos do Microsoft Entra. Uma vez conectado, o Microsoft Entra ID executa um processo de sincronização. O processo acontece a cada 40 minutos. O processo consulta o ponto de extremidade SCIM do aplicativo para os usuários e grupos atribuídos e os cria ou modifica de acordo com os detalhes da atribuição.

Para conectar um aplicativo que dê suporte a SCIM:

  1. Entre no Centro de administração do Microsoft Entra pelo menos como um Administrador de Aplicativo.

  2. Navegue até Identidade>Aplicativos>Aplicativos empresariais.

  3. Uma lista com todos os aplicativos configurados é exibida, incluindo os aplicativos adicionados da galeria.

  4. Selecione + Novo aplicativo>+ Criar seu próprio aplicativo.

  5. Insira um nome para o aplicativo, escolha a opção "integre qualquer outro aplicativo que você não encontre na galeria" e selecione Adicionar para criar um objeto de aplicativo. O novo aplicativo é adicionado à lista de aplicativos empresariais e é aberto em sua tela de gerenciamento de aplicativo.

    A captura de tela a seguir mostra a galeria de aplicativos do Microsoft Entra:

    A captura de tela mostra a galeria de aplicativos do Microsoft Entra.

  6. Na tela de gerenciamento de aplicativos, selecione Provisionamento no painel esquerdo.

  7. No menu Modo Provisionamento, selecione Automático.

    A captura de tela a seguir mostra as configurações de provisionamento de configuração no centro de administração do Microsoft Entra:

    Captura de tela da página de provisionamento do aplicativo no centro de administração do Microsoft Entra.

  8. No campo URL do locatário, insira a URL do ponto de extremidade do SCIM do aplicativo. Exemplo: https://api.contoso.com/scim/

  9. Se o ponto de extremidade SCIM exigir um token de portador OAuth de um emissor diferente do Microsoft Entra ID, copie o token de portador OAuth necessário para o campo opcional Token Secreto. Esse campo fica em branco, o Microsoft Entra ID inclui um token de portador OAuth emitido do Microsoft Entra ID com cada solicitação. Os aplicativos que usam o Microsoft Entra ID como provedor de identidade podem validar esse token emitido pelo Microsoft Entra ID.

    Observação

    Não recomendamos deixar esse campo em branco e contar com um token gerado pelo Microsoft Entra ID. Essa opção está disponível principalmente para fins de teste.

  10. Selecione Testar Conectividade para que o Microsoft Entra ID tente se conectar ao ponto de extremidade do SCIM. Se a tentativa falhar, as informações de erro serão exibidas.

    Observação

    Testar Conexão consulta o ponto de extremidade SCIM para um usuário que não existe, usando um GUID aleatório como a propriedade correspondente selecionada na configuração do Microsoft Entra. A resposta correta esperada é HTTP 200 OK com uma mensagem de SCIM ListResponse vazia.

  11. Se as tentativas de conexão ao aplicativo forem bem-sucedidas, selecione Salvar para salvar as credenciais de administrador.

  12. Na seção Mapeamento, há dois conjuntos selecionáveis de mapeamentos de atributos: um para objetos de usuário e outro para objetos de grupo. Selecione cada um para revisar os atributos sincronizados do Microsoft Entra ID para o aplicativo. Os atributos selecionados como propriedades Correspondentes serão usados para fazer a correspondência entre os usuários e os grupos no seu aplicativo para operações de atualização. Para confirmar as alterações, selecione Salvar.

    Observação

    Opcionalmente, você pode desabilitar a sincronização dos objetos de grupo desabilitando o mapeamento de "grupos".

  13. Em Configurações, o campo Escopo define quais usuários e grupos são sincronizados. Selecione Sincronizar apenas usuários e grupos atribuídos (recomendado) sincroniza somente usuários e grupos atribuídos na guia Usuários e grupos.

  14. Depois que a configuração for concluída, defina o Status de provisionamento para Ativado.

  15. Selecione Salvar para iniciar o serviço de provisionamento do Microsoft Entra.

  16. Caso esteja sincronizando apenas os usuários e grupos atribuídos (recomendado), selecione a guia Usuários e grupos. Em seguida, atribua os usuários ou grupos que você deseja sincronizar.

Depois que o ciclo inicial for iniciado, você poderá selecionar Logs de provisionamento no painel esquerdo para monitorar o progresso, que mostra todas as ações realizadas pelo serviço de provisionamento em seu aplicativo. Para obter mais informações sobre como ler os logs de provisionamento do Microsoft Entra, confira Relatórios sobre o provisionamento automático de contas de usuário.

Observação

O ciclo inicial demora mais do que as sincronizações posteriores, que ocorrem aproximadamente a cada 40 minutos, contanto que o serviço esteja em execução.

Se você estiver criando um aplicativo que será usado por mais de um locatário, disponibilize-o na galeria de aplicativos do Microsoft Entra. É fácil para as organizações descobrirem o aplicativo e configurarem o provisionamento. Publicar o aplicativo na galeria do Microsoft Entra e disponibilizar o provisionamento para outras pessoas é fácil. Confira as etapas aqui. A Microsoft trabalha com você para integrar seu aplicativo na galeria, testar seu ponto de extremidade e lançar a documentação de integração para clientes.

Use a lista de verificação para integrar o aplicativo rapidamente e para que os clientes tenham uma experiência de implantação tranquila. As informações serão coletadas quando você estiver realizando a integração à galeria.

  • Suporte a um ponto de extremidade de usuário e grupo do SCIM 2.0 (apenas um é necessário, mas ambos são recomendados)
  • Suporte a pelo menos 25 solicitações por segundo e por locatário para garantir que usuários e grupos sejam provisionados e desprovisionados sem atraso (obrigatório)
  • Estabelecer contatos de engenharia e suporte para orientar os clientes após a integração à galeria (obrigatório)
  • 3 credenciais de teste sem expiração para o aplicativo (obrigatório)
  • Suporte à concessão de código de autorização OAuth ou a um token de longa duração, conforme descrito no exemplo (obrigatório)
  • Os aplicativos OIDC devem ter pelo menos uma função (personalizada ou padrão) definida
  • Estabelecer um ponto de contato de engenharia e suporte para ajudar os clientes após a integração à galeria (obrigatório)
  • Suporte à descoberta de esquema (obrigatório)
  • Suporte à atualização de várias associações de grupo com um único PATCH
  • Documentar o ponto de extremidade do SCIM publicamente

A especificação do SCIM não define um esquema específico de SCIM para autenticação e autorização e se baseia no uso de padrões existentes do setor.

Método de autorização Vantagens Desvantagens Suporte
Nome de usuário e senha (não recomendado ou com suporte do Microsoft Entra ID) Fácil de implementar Inseguro – Sua $enha não importa Sem suporte para aplicativos que não são ou que são da nova galeria.
Token de portador de longa duração Os tokens de longa duração não exigem que um usuário esteja presente. Eles são fáceis para os administradores usarem quando configuram o provisionamento. Os tokens de longa duração podem ser difíceis de compartilhar com um administrador sem usar métodos inseguros, como email. Com suporte para aplicativos dentro e fora da galeria.
Concessão de código de autorização OAuth Os tokens de acesso têm uma vida útil mais curta do que as senhas e têm um mecanismo de atualização automatizado que os tokens de portador de longa duração não têm. Um usuário real deve estar presente durante a autorização inicial, o que adiciona um nível de responsabilidade. Exige que um usuário esteja presente. Se o usuário sair da organização, o token se tornará inválido e a autorização precisará ser realizada novamente. Com suporte para aplicativos na galeria, porém não para aplicativos fora da galeria. No entanto, é possível fornecer um token de acesso na interface do usuário como um token secreto para fins de teste de curto prazo. Suporte para concessão de código OAuth em aplicativos que não são da galeria está em nossa lista de pendências, além do suporte a URLs de autenticação/token configuráveis no aplicativo da galeria.
Concessão de credenciais de cliente do OAuth Os tokens de acesso têm uma vida útil mais curta do que as senhas e têm um mecanismo de atualização automatizado que os tokens de portador de longa duração não têm. A concessão de código de autorização e a concessão de credenciais de cliente criam o mesmo tipo de token de acesso; portanto, a transferência entre esses métodos é transparente para a API. O provisionamento pode ser automatizado e novos tokens podem ser silenciosamente solicitados sem interação do usuário. Com suporte para aplicativos na galeria, porém não para aplicativos fora da galeria. No entanto, é possível fornecer um token de acesso na interface do usuário como um token secreto para fins de teste de curto prazo. Suporte à concessão de credenciais do cliente OAuth fora da galeria não está em nossa lista de pendências.

Observação

Não é recomendável deixar o campo de token em branco na interface do usuário do aplicativo personalizado de configuração de provisionamento do Microsoft Entra. O token gerado está disponível principalmente para fins de teste.

Fluxo de concessão de código OAuth

O serviço de provisionamento dá suporte à concessão de código de autorização e, depois de enviar a solicitação para publicar o aplicativo na galeria, nossa equipe trabalhará com você para coletar as seguintes informações:

  • URL de Autorização, uma URL pelo cliente para obter autorização do proprietário do recurso por meio do redirecionamento de agente do usuário. O usuário é redirecionado a essa URL para autorizar o acesso.

  • URL de troca de token, uma URL pelo cliente para trocar uma concessão de autorização para um token de acesso, normalmente com autenticação de cliente.

  • ID de Cliente, o servidor de autorização emite ao cliente registrado um identificador de cliente, que é uma cadeia de caracteres exclusiva que representa as informações de registro fornecidas pelo cliente. O identificador do cliente não é um segredo; ele é exposto ao proprietário do recurso e não deve ser usado por sozinho para autenticação do cliente.

  • Segredo do cliente, um segredo gerado pelo servidor de autorização que deve ser um valor exclusivo conhecido apenas pelo servidor de autorização.

Observação

A URL de Autorização e a URL de troca de token atualmente não são configuráveis por locatário.

Observação

O OAuth v1 não tem suporte devido à exposição do segredo do cliente. O OAuth v2 é compatível.

Ao usar o fluxo de concessão de código OAuth, é necessário oferecer suporte a um modelo em que cada cliente enviará a própria ID do cliente e o segredo do cliente ao configurar uma instância de provisionamento. Não há suporte para um único par de ID do cliente/segredo do cliente em todo o aplicativo.

Como configurar o fluxo de concessão de código OAuth

  1. Entre no Centro de administração do Microsoft Entra pelo menos como um Administrador de Aplicativo.

  2. Navegue até Identidade>Aplicativos>Aplicativos empresariais>Aplicativos>Provisionamento e selecione Autorizar.

  3. Entre no Centro de administração do Microsoft Entra pelo menos como um Administrador de Aplicativo.

  4. Navegue até Identidade>Aplicativos>Aplicativos empresariais.

  5. Selecione seu aplicativo e vá para Provisionamento.

  6. Selecione Autorizar.

    1. Os usuários são redirecionados para a URL de autorização (página de entrada do aplicativo de terceiros).

    2. O administrador fornecerá credenciais para o aplicativo de terceiros.

    3. O aplicativo de terceiros redireciona o usuário de volta e fornece o código de concessão

    4. O Serviço de Provisionamento chama a URL do token e fornece o código de concessão. O aplicativo de terceiros responderá com o token de acesso, o token de atualização e a data de expiração

  7. Quando o ciclo de provisionamento for iniciado, o serviço verificará se o token de acesso atual é válido e o trocará por um novo token, se necessário. Um token de acesso será fornecido em cada solicitação feita ao aplicativo e a validade da solicitação será verificada antes de cada solicitação.

Observação

Embora atualmente não seja possível configurar o OAuth nos aplicativos fora da galeria, você poderá gerar um token de acesso de modo manual no servidor de autorização e inseri-lo como o token secreto de um aplicativo fora da galeria. Isso permitirá verificar a compatibilidade do servidor SCIM com o serviço de provisionamento do Microsoft Entra, antes de realizar a integração à galeria de aplicativos, compatível com a concessão do código OAuth.

Tokens de portador OAuth de longa duração: se o aplicativo não for compatível com o fluxo de concessão de código de autorização OAuth, gere um token de portador OAuth de longa duração que um administrador possa usar para configurar a integração de provisionamento. O token deve ser perpétuo, caso contrário, o trabalho de provisionamento ficará em quarentena quando o token expirar.

Para obter mais métodos de autenticação e autorização, entre em contato pelo UserVoice.

Para impulsionar o reconhecimento e a demanda da nossa integração conjunta, recomendamos que você atualize a documentação existente e amplifique a integração em seus canais de marketing. Recomendamos que você conclua a seguinte lista de verificação para dar suporte à inicialização:

  • Verifique se as equipes de vendas e de suporte ao cliente estão cientes, prontas e podem se comunicar com os recursos de integração. Comunique suas equipes, forneça perguntas frequentes e inclua a integração em seus materiais de vendas.
  • Crie uma postagem no blog ou um comunicado à imprensa que descreva a integração conjunta, os benefícios e como começar. Exemplo: comunicado à imprensa da Imprivata e Microsoft Entra
  • Aproveite as redes sociais, como o X, o Facebook ou o LinkedIn, para promover a integração aos seus clientes. Inclua o @Microsoft Entra ID de forma que possamos enviar o retweet da sua postagem. Exemplo: Imprivata X Post
  • Crie ou atualize suas páginas/ site de marketing (por exemplo, página de integração, página de parceiro, página de preços etc.) para incluir a disponibilidade da integração conjunta. Exemplo: página de integração do Pingboard, página de integração do Smartsheet, página de preços do Monday.com
  • Criar um artigo da central de ajuda ou documentação técnica sobre como os clientes podem começar. Exemplo: integração do Envoy + Microsoft Entra.
  • Alerte os clientes sobre a nova integração por meio da comunicação com os clientes (boletins informativos mensais, campanhas de email, notas de versão do produto).

Próximas etapas

Desenvolver um exemplo de ponto de extremidade de SCIMAutomatizar o provisionamento e desprovisionamento de usuários para aplicativos SaaSPersonalizar mapeamentos de atributos para provisionamento de usuáriosEscrever expressões para mapeamentos de atributosFiltros de escopo para provisionamento de usuáriosNotificações de provisionamento da contaLista de tutoriais sobre como integrar aplicativos SaaS