Compartilhar via


Criar históricoDefinições

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.

Crie um novo objeto accessReviewHistoryDefinition .

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) AccessReview.ReadWrite.All Indisponível.
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Application AccessReview.ReadWrite.All Indisponível.

Em cenários delegados com contas escolares ou profissionais, o utilizador com sessão iniciada tem de ter uma função suportada do Microsoft Entra ou uma função personalizada com uma permissão de função suportada. As seguintes funções com menos privilégios são suportadas para esta operação.

Escrever revisões de acesso de um grupo ou aplicação Escrever revisões de acesso de uma função do Microsoft Entra
Administrador do usuário
Administrador de Governação de Identidades
Administrador de Funções Privilegiadas do Administrador
de Governação de Identidade

Solicitação HTTP

POST /identityGovernance/accessReviews/historyDefinitions

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 do pedido, forneça uma representação JSON do objeto accessReviewHistoryDefinition .

A tabela seguinte mostra as propriedades necessárias utilizadas para criar um accessReviewHistoryDefinition.

Propriedade Tipo Descrição
displayName Cadeia de caracteres Nome para a recolha de dados do histórico de revisão de acesso. Obrigatório.
reviewHistoryPeriodStartDateTime DateTimeOffset Um carimbo de data/hora. As revisões a partir de ou depois desta data estão nos dados do histórico obtido. Só é necessário se scheduleSettings não estiver definido.
reviewHistoryPeriodEndDateTime DateTimeOffset Um carimbo de data/hora. As revisões a partir de ou antes desta data são incluídas nos dados do histórico obtido. Só é necessário se scheduleSettings não estiver definido.
escopos accessReviewQueryScope collection (coleção accessReviewQueryScope ) Utilizado para filtrar as críticas incluídas nos dados do histórico obtido. Obtém as revisões cujo âmbito corresponde a este âmbito fornecido. Obrigatório.
Para obter mais informações, veja Consultas de âmbito suportadas para accessReviewHistoryDefinition.
scheduleSettings accessReviewHistoryScheduleSettings Ainda não é suportado. As definições de uma série de definições do histórico de revisão de acesso periódico. Só é necessário se reviewHistoryPeriodStartDateTime ou reviewHistoryPeriodEndDateTime não estiverem definidos.

Consultas de âmbito suportadas para accessReviewHistoryDefinition

O $filter parâmetro de consulta com o contains operador é suportado na propriedade de âmbito de accessReviewScheduleDefinition. Utilize o seguinte formato para o pedido:

/identityGovernance/accessReviews/definitions?$filter=contains(scope/microsoft.graph.accessReviewQueryScope/query, '{object}')

O {object} pode ter um dos seguintes valores:

Valor Descrição
/groups Liste todos os accessReviewScheduleDefinition em grupos individuais (exclui definições no âmbito de todos os grupos do Microsoft 365 com convidados).
/groups/{group id} Liste todos os accessReviewScheduleDefinition num grupo específico (exclui definições no âmbito de todos os grupos do Microsoft 365 com convidados).
./members Liste todos os accessReviewScheduleDefinition no âmbito de todos os grupos do Microsoft 365 com convidados.
accessPackageAssignments Liste todos os accessReviewScheduleDefinition num pacote de acesso.
roleAssignmentScheduleInstances Liste todos os accessReviewScheduleDefinition para principais atribuídos a uma função com privilégios.

O $filter parâmetro de consulta não é suportado no accessReviewInactiveUserQueryScope ou principalResourceMembershipScope.

Resposta

Se for bem-sucedido, este método devolve um 201 Created código de resposta e um objeto accessReviewHistoryDefinition no corpo da resposta.

Exemplos

O exemplo seguinte mostra como criar uma definição do histórico de revisão de acesso no âmbito de revisões de acesso em pacotes e grupos de acesso, em execução entre a data de início de 01/01/2021 e a data de fim de 05/04/2021.

Solicitação

POST https://graph.microsoft.com/beta/identityGovernance/accessReviews/historyDefinitions
Content-Type: application/json

{
  "displayName": "Last quarter's group reviews April 2021",
  "decisions": [
    "approve",
    "deny",
    "dontKnow",
    "notReviewed",
    "notNotified"
  ],
  "reviewHistoryPeriodStartDateTime": "2021-01-01T00:00:00Z",
  "reviewHistoryPeriodEndDateTime": "2021-04-30T23:59:59Z",
  "scopes": [
    {
      "@odata.type": "#microsoft.graph.accessReviewQueryScope",
      "queryType": "MicrosoftGraph",     
      "query": "/identityGovernance/accessReviews/definitions?$filter=contains(scope/query, 'accessPackageAssignments')",
      "queryRoot": null
    },  
    {
      "@odata.type": "#microsoft.graph.accessReviewQueryScope",
      "queryType": "MicrosoftGraph",     
      "query": "/identityGovernance/accessReviews/definitions?$filter=contains(scope/query, '/groups')",
      "queryRoot": null
    }
  ]
}

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.accessReviewHistoryDefinition",
    "id": "b2cb022f-b7e1-40f3-9854-c65a40861c38",
    "displayName": "Last quarter's group reviews April 2021",
    "reviewHistoryPeriodStartDateTime": "2021-01-01T00:00:00Z",
    "reviewHistoryPeriodEndDateTime": "2021-04-30T23:59:59Z",
    "decisions": [
        "approve",
        "deny",
        "dontKnow",
        "notReviewed",
        "notNotified"
    ],
    "status": "requested",
    "createdDateTime": "2021-04-14T00:22:48.9392594Z",
    "createdBy": {
        "id": "957f1027-c0ee-460d-9269-b8444459e0fe",
        "displayName": "MOD Administrator",
        "userPrincipalName": "admin@contoso.com"
    },
    "scopes": [
        {
            "@odata.type": "#microsoft.graph.accessReviewQueryScope",
            "queryType": "MicrosoftGraph",
            "query": "/identityGovernance/accessReviews/definitions?$filter=contains(scope/query, 'accessPackageAssignments')",
            "queryRoot": null
        },
        {
            "@odata.type": "#microsoft.graph.accessReviewQueryScope",
            "queryType": "MicrosoftGraph",
            "query": "/identityGovernance/accessReviews/definitions?$filter=contains(scope/query, '/groups')",
            "queryRoot": null
        }
    ]
}