Eventos do Microsoft Entra

  • Artigo

Este artigo fornece as propriedades e o esquema de eventos do Microsoft Entra, que são publicados pela API do Microsoft Graph. Para obter uma introdução aos esquemas de eventos, confira Esquema do CloudEvents.

Tipos de evento disponíveis

Esses eventos são disparados quando um usuário ou um grupo é criado, atualizado ou excluído no Microsoft Entra ID ou por operações nesses recursos por meio da API do Microsoft Graph.

Nome do evento Descrição
Microsoft.Graph.UserUpdated Disparado quando um usuário do Microsoft Entra ID é criado ou atualizado.
Microsoft.Graph.UserDeleted Disparado quando um usuário do Microsoft Entra ID é excluído permanentemente.
Microsoft.Graph.GroupUpdated Disparado quando um grupo do Microsoft Entra ID é criado ou atualizado.
Microsoft.Graph.GroupDeleted Disparado quando um grupo do Microsoft Entra ID é excluído permanentemente.

Observação

Por padrão, excluir um usuário ou um grupo é apenas uma operação de exclusão reversível, o que significa que o usuário ou grupo fica marcado como excluído, mas o objeto de usuário ou de grupo ainda existe. O Microsoft Graph envia um evento atualizado quando os usuários são excluídos de modo reversível. Para excluir permanentemente um usuário, navegue até a página Excluir usuários no portal do Azure e selecione Excluir permanentemente. As etapas para excluir permanentemente um grupo são semelhantes.

Exemplo de evento

Quando um evento é disparado, o serviço Grade de Eventos envia dados sobre esse evento aos destinos assinantes. Esta seção contém um exemplo da aparência dos dados em cada evento do Microsoft Entra.

Evento Microsoft.Graph.UserUpdated

{
  "id": "00d8a100-2e92-4bfa-86e1-0056dacd0fce",
  "type": "Microsoft.Graph.UserUpdated",
  "source": "/tenants/<tenant-id>/applications/<application-id>",
  "subject": "Users/<user-id>",
  "time": "2022-05-24T22:24:31.3062901Z",
  "datacontenttype": "application/json",
  "specversion": "1.0",
  "data": {
    "changeType": "updated",
    "clientState": "<guid>",
    "resource": "Users/<user-id>",
    "resourceData": {
      "@odata.type": "#Microsoft.Graph.User",
      "@odata.id": "Users/<user-id>",
      "id": "<user-id>",
      "organizationId": "<tenant-id>",
      "eventTime": "2022-05-24T22:24:31.3062901Z",
      "sequenceNumber": <sequence-number>
    },
    "subscriptionExpirationDateTime": "2022-05-24T23:21:19.3554403+00:00",
    "subscriptionId": "<microsoft-graph-subscription-id>",
    "tenantId": "<tenant-id>
  }
}

Evento Microsoft.Graph.UserDeleted

{
  "id": "00d8a100-2e92-4bfa-86e1-0056dacd0fce",
  "type": "Microsoft.Graph.UserDeleted",
  "source": "/tenants/<tenant-id>/applications/<application-id>",
  "subject": "Users/<user-id>",
  "time": "2022-05-24T22:24:31.3062901Z",
  "datacontenttype": "application/json",
  "specversion": "1.0",
  "data": {
    "changeType": "deleted",
    "clientState": "<guid>",
    "resource": "Users/<user-id>",
    "resourceData": {
      "@odata.type": "#Microsoft.Graph.User",
      "@odata.id": "Users/<user-id>",
      "id": "<user-id>",
      "organizationId": "<tenant-id>",
      "eventTime": "2022-05-24T22:24:31.3062901Z",
      "sequenceNumber": <sequence-number>
    },
    "subscriptionExpirationDateTime": "2022-05-24T23:21:19.3554403+00:00",
    "subscriptionId": "<microsoft-graph-subscription-id>",
    "tenantId": "<tenant-id>
  }
}

Evento Microsoft.Graph.GroupUpdated

{
  "id": "00d8a100-2e92-4bfa-86e1-0056dacd0fce",
  "type": "Microsoft.Graph.GroupUpdated",
  "source": "/tenants/<tenant-id>/applications/<application-id>",
  "subject": "Groups/<group-id>",
  "time": "2022-05-24T22:24:31.3062901Z",
  "datacontenttype": "application/json",
  "specversion": "1.0",
  "data": {
    "changeType": "updated",
    "clientState": "<guid>",
    "resource": "Groups/<group-id>",
    "resourceData": {
      "@odata.type": "#Microsoft.Graph.Group",
      "@odata.id": "Groups/<group-id>",
      "id": "<group-id>",
      "organizationId": "<tenant-id>",
      "eventTime": "2022-05-24T22:24:31.3062901Z",
      "sequenceNumber": <sequence-number>
    },
    "subscriptionExpirationDateTime": "2022-05-24T23:21:19.3554403+00:00",
    "subscriptionId": "<microsoft-graph-subscription-id>",
    "tenantId": "<tenant-id>
  }
}

Evento Microsoft.Graph.GroupDeleted

{
  "id": "00d8a100-2e92-4bfa-86e1-0056dacd0fce",
  "type": "Microsoft.Graph.GroupDeleted",
  "source": "/tenants/<tenant-id>/applications/<application-id>",
  "subject": "Groups/<group-id>",
  "time": "2022-05-24T22:24:31.3062901Z",
  "datacontenttype": "application/json",
  "specversion": "1.0",
  "data": {
    "changeType": "deleted",
    "clientState": "<guid>",
    "resource": "Groups/<group-id>",
    "resourceData": {
      "@odata.type": "#Microsoft.Graph.Group",
      "@odata.id": "Groups/<group-id>",
      "id": "<group-id>",
      "organizationId": "<tenant-id>",
      "eventTime": "2022-05-24T22:24:31.3062901Z",
      "sequenceNumber": <sequence-number>
    },
    "subscriptionExpirationDateTime": "2022-05-24T23:21:19.3554403+00:00",
    "subscriptionId": "<microsoft-graph-subscription-id>",
    "tenantId": "<tenant-id>
  }
}

Propriedades do evento

Um evento tem os seguintes dados de nível superior:

Propriedade Type Descrição
source string A origem do evento do locatário. Este campo não é gravável. A API do Microsoft Graph fornece esse valor.
subject string Caminho definido pelo publicador para o assunto do evento.
type string Um dos tipos de evento dessa origem do evento.
time string A hora em que o evento é gerado com base na hora UTC do provedor
id string Identificador exclusivo do evento.
data objeto Conteúdo do evento que fornece os dados sobre a alteração de estado do recurso.
specversion string Versão de especificação do esquema CloudEvents.

O objeto de dados tem as seguintes propriedades:

Propriedade Type Descrição
changeType string O tipo de alteração de estado do recurso.
resource string O identificador de recurso para o qual o evento foi gerado.
tenantId string A ID da organização que contém o usuário ou o grupo.
clientState string Um segredo fornecido pelo usuário no momento da criação da assinatura da API do Graph.
@odata.type string O tipo de alteração da API do Graph.
@odata.id string O identificador do recurso da API do Graph para o qual o evento foi gerado.
id string O identificador de recurso para o qual o evento foi gerado.
organizationId string O identificador de locatário do Microsoft Entra.
eventTime string A hora em que o estado do recurso foi alterado.
sequenceNumber string Um número de sequência.
subscriptionExpirationDateTime string A hora no formato RFC 3339 em que a assinatura da API do Graph expira.
subscriptionId string O identificador da assinatura da API do Graph.
tenantId string O identificador de locatário do Microsoft Entra.

Próximas etapas