Criar accessReview (preterido)

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 de versão.

Observação

As APIs de revisão de acesso estão preteridas e deixarão de retornar dados em 19 de maio de 2023. Use as avaliações do Access.

No recurso Azure AD revisões de acesso, crie um novo objeto accessReview.

Antes de fazer essa solicitação, o chamador deve ter recuperado anteriormente a lista de modelos de fluxo de negócios, para ter o valor de businessFlowTemplateId a ser incluído na solicitação.

Depois de fazer essa solicitação, o chamador deve criar um programControl para vincular a revisão de acesso a um programa.

Permissões

Uma das seguintes permissões é obrigatória para chamar esta API. Para saber mais, incluindo como escolher permissões, confira Permissões.

Tipo de permissão	Permissões (da com menos para a com mais privilégios)
Delegada (conta corporativa ou de estudante)	AccessReview.ReadWrite.Membership, AccessReview.ReadWrite.All
Delegada (conta pessoal da Microsoft)	Sem suporte.
Application	AccessReview.ReadWrite.Membership

O chamador também deve ter a permissão ProgramControl.ReadWrite.All, para que, depois de criar uma revisão de acesso, o chamador possa criar um programControl. Além disso, o usuário conectado também deve estar em uma função de diretório que permita que ele crie uma revisão de acesso. Para obter mais detalhes, consulte os requisitos de função e permissão para revisões de acesso.

Solicitação HTTP

POST /accessReviews

Cabeçalhos de solicitação

Nome	Descrição
Autorização	{token} de portador. Obrigatório.
Content-type	application/json. Obrigatório.

Corpo da solicitação

No corpo da solicitação, forneça uma representação JSON de um objeto accessReview .

A tabela a seguir mostra as propriedades que são necessárias ao criar um accessReview.

Propriedade	Tipo	Descrição
displayName	String	O nome da revisão de acesso.
startDateTime	DateTimeOffset	O DateTime quando a revisão está agendada para ser iniciada. Isso deve ser uma data no futuro.
endDateTime	DateTimeOffset	O DateTime quando a revisão está agendada para terminar. Isso deve ser pelo menos um dia depois da data de início.
description	String	A descrição, a ser mostrada aos revisores.
businessFlowTemplateId	Cadeia de caracteres	O identificador do modelo de fluxo de negócios, obtido de um businessFlowTemplate.
reviewerType	String	O tipo de relação do revistor com os direitos de acesso do objeto revisado, um de self, delegatedou entityOwners.
reviewedEntity	identity	O objeto para o qual uma revisão de acesso é criada, como a associação de um grupo ou as atribuições de usuários a um aplicativo.

Se o reviewerType delegatedtiver o valor, o chamador também deverá incluir a propriedade reviewers , com uma coleção de objetos userIdentity que representam os revisores.

Se seu aplicativo estiver chamando essa API sem um usuário conectado, o chamador também deverá incluir a propriedade createdBy , o valor para o qual é uma userIdentity do usuário que será identificado como o criador da revisão.

Além disso, o chamador pode incluir configurações para criar uma série de revisão recorrente ou para alterar o comportamento de revisão padrão. Em particular, para criar uma revisão recorrente, o chamador deve incluir accessReviewRecurrenceSettings dentro das configurações de revisão de acesso,

Resposta

Se tiver êxito, este método retornará um código 201 Created de resposta e um objeto accessReview no corpo da resposta.

Exemplo

Este é um exemplo de criação de uma revisão de acesso única (não recorrente), especificando explicitamente dois usuários como revisores.

Solicitação

No corpo da solicitação, forneça uma representação JSON do objeto accessReview .

HTTP

POST https://graph.microsoft.com/beta/accessReviews
Content-type: application/json

{
    "displayName":"TestReview",
    "startDateTime":"2017-02-10T00:35:53.214Z",
    "endDateTime":"2017-03-12T00:35:53.214Z",
    "reviewedEntity": {
        "id": "99025615-a0b1-47ec-9117-35377b10998b"
    },
    "reviewerType" : "delegated",
    "businessFlowTemplateId": "6e4f3d20-c5c3-407f-9695-8460952bcc68",
    "description":"Sample description",
    "reviewers":
    [
        {
            "id":"f260246a-09b1-4fd5-8d18-daed736071ec"
        },
        {
            "id":"5a4e184c-4ee5-4883-96e9-b371f8da88e3"
        }
    ],
    "settings":
    {
        "mailNotificationsEnabled": true,
        "remindersEnabled": true,
        "justificationRequiredOnApproval":true,
        "autoReviewEnabled":false,
        "activityDurationInDays":30,
        "autoApplyReviewResultsEnabled":false,
        "accessRecommendationsEnabled":false,
        "recurrenceSettings":{
            "recurrenceType":"onetime",
            "recurrenceEndType":"endBy",
            "durationInDays":0,
            "recurrenceCount":0
        },
        "autoReviewSettings":{
            "notReviewedResult":"Deny"
        }
    }
}

C#

GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var accessReview = new AccessReview
{
    DisplayName = "TestReview",
    StartDateTime = DateTimeOffset.Parse("2017-02-10T00:35:53.214Z"),
    EndDateTime = DateTimeOffset.Parse("2017-03-12T00:35:53.214Z"),
    ReviewedEntity = new Identity
    {
        Id = "99025615-a0b1-47ec-9117-35377b10998b"
    },
    ReviewerType = "delegated",
    BusinessFlowTemplateId = "6e4f3d20-c5c3-407f-9695-8460952bcc68",
    Description = "Sample description",
    Reviewers = new AccessReviewReviewersCollectionPage()
    {
        new AccessReviewReviewer
        {
            Id = "f260246a-09b1-4fd5-8d18-daed736071ec"
        },
        new AccessReviewReviewer
        {
            Id = "5a4e184c-4ee5-4883-96e9-b371f8da88e3"
        }
    },
    Settings = new AccessReviewSettings
    {
        MailNotificationsEnabled = true,
        RemindersEnabled = true,
        JustificationRequiredOnApproval = true,
        AutoReviewEnabled = false,
        ActivityDurationInDays = 30,
        AutoApplyReviewResultsEnabled = false,
        AccessRecommendationsEnabled = false,
        RecurrenceSettings = new AccessReviewRecurrenceSettings
        {
            RecurrenceType = "onetime",
            RecurrenceEndType = "endBy",
            DurationInDays = 0,
            RecurrenceCount = 0
        },
        AutoReviewSettings = new AutoReviewSettings
        {
            NotReviewedResult = "Deny"
        }
    }
};

await graphClient.AccessReviews
    .Request()
    .AddAsync(accessReview);

Importante

Os SDKs do Microsoft Graph usam a versão v1.0 da API por padrão e não dão suporte a todos os tipos, propriedades e APIs disponíveis na versão beta. Para obter detalhes sobre como acessar a API beta com o SDK, consulte Usar os SDKs do Microsoft Graph com a API beta.

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider , consulte a documentação do SDK.

JavaScript

const options = {
    authProvider,
};

const client = Client.init(options);

const accessReview = {
    displayName: 'TestReview',
    startDateTime: '2017-02-10T00:35:53.214Z',
    endDateTime: '2017-03-12T00:35:53.214Z',
    reviewedEntity: {
        id: '99025615-a0b1-47ec-9117-35377b10998b'
    },
    reviewerType: 'delegated',
    businessFlowTemplateId: '6e4f3d20-c5c3-407f-9695-8460952bcc68',
    description: 'Sample description',
    reviewers: 
    [
        {
            id: 'f260246a-09b1-4fd5-8d18-daed736071ec'
        },
        {
            id: '5a4e184c-4ee5-4883-96e9-b371f8da88e3'
        }
    ],
    settings: 
    {
        mailNotificationsEnabled: true,
        remindersEnabled: true,
        justificationRequiredOnApproval: true,
        autoReviewEnabled: false,
        activityDurationInDays: 30,
        autoApplyReviewResultsEnabled: false,
        accessRecommendationsEnabled: false,
        recurrenceSettings: {
            recurrenceType: 'onetime',
            recurrenceEndType: 'endBy',
            durationInDays: 0,
            recurrenceCount: 0
        },
        autoReviewSettings: {
            notReviewedResult: 'Deny'
        }
    }
};

await client.api('/accessReviews')
    .version('beta')
    .post(accessReview);

Importante

Os SDKs do Microsoft Graph usam a versão v1.0 da API por padrão e não dão suporte a todos os tipos, propriedades e APIs disponíveis na versão beta. Para obter detalhes sobre como acessar a API beta com o SDK, consulte Usar os SDKs do Microsoft Graph com a API beta.

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider , consulte a documentação do SDK.

Objective-C

MSHTTPClient *httpClient = [MSClientFactory createHTTPClientWithAuthenticationProvider:authenticationProvider];

NSString *MSGraphBaseURL = @"https://graph.microsoft.com/beta/";
NSMutableURLRequest *urlRequest = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:[MSGraphBaseURL stringByAppendingString:@"/accessReviews"]]];
[urlRequest setHTTPMethod:@"POST"];
[urlRequest setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];

MSGraphAccessReview *accessReview = [[MSGraphAccessReview alloc] init];
[accessReview setDisplayName:@"TestReview"];
[accessReview setStartDateTime: "2017-02-10T00:35:53.214Z"];
[accessReview setEndDateTime: "2017-03-12T00:35:53.214Z"];
MSGraphIdentity *reviewedEntity = [[MSGraphIdentity alloc] init];
[reviewedEntity setId:@"99025615-a0b1-47ec-9117-35377b10998b"];
[accessReview setReviewedEntity:reviewedEntity];
[accessReview setReviewerType:@"delegated"];
[accessReview setBusinessFlowTemplateId:@"6e4f3d20-c5c3-407f-9695-8460952bcc68"];
[accessReview setDescription:@"Sample description"];
NSMutableArray *reviewersList = [[NSMutableArray alloc] init];
MSGraphAccessReviewReviewer *reviewers = [[MSGraphAccessReviewReviewer alloc] init];
[reviewers setId:@"f260246a-09b1-4fd5-8d18-daed736071ec"];
[reviewersList addObject: reviewers];
MSGraphAccessReviewReviewer *reviewers = [[MSGraphAccessReviewReviewer alloc] init];
[reviewers setId:@"5a4e184c-4ee5-4883-96e9-b371f8da88e3"];
[reviewersList addObject: reviewers];
[accessReview setReviewers:reviewersList];
MSGraphAccessReviewSettings *settings = [[MSGraphAccessReviewSettings alloc] init];
[settings setMailNotificationsEnabled: true];
[settings setRemindersEnabled: true];
[settings setJustificationRequiredOnApproval: true];
[settings setAutoReviewEnabled: false];
[settings setActivityDurationInDays: 30];
[settings setAutoApplyReviewResultsEnabled: false];
[settings setAccessRecommendationsEnabled: false];
MSGraphAccessReviewRecurrenceSettings *recurrenceSettings = [[MSGraphAccessReviewRecurrenceSettings alloc] init];
[recurrenceSettings setRecurrenceType:@"onetime"];
[recurrenceSettings setRecurrenceEndType:@"endBy"];
[recurrenceSettings setDurationInDays: 0];
[recurrenceSettings setRecurrenceCount: 0];
[settings setRecurrenceSettings:recurrenceSettings];
MSGraphAutoReviewSettings *autoReviewSettings = [[MSGraphAutoReviewSettings alloc] init];
[autoReviewSettings setNotReviewedResult:@"Deny"];
[settings setAutoReviewSettings:autoReviewSettings];
[accessReview setSettings:settings];

NSError *error;
NSData *accessReviewData = [accessReview getSerializedDataWithError:&error];
[urlRequest setHTTPBody:accessReviewData];

MSURLSessionDataTask *meDataTask = [httpClient dataTaskWithRequest:urlRequest 
    completionHandler: ^(NSData *data, NSURLResponse *response, NSError *nserror) {

        //Request Completed

}];

[meDataTask execute];

Importante

Os SDKs do Microsoft Graph usam a versão v1.0 da API por padrão e não dão suporte a todos os tipos, propriedades e APIs disponíveis na versão beta. Para obter detalhes sobre como acessar a API beta com o SDK, consulte Usar os SDKs do Microsoft Graph com a API beta.

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider , consulte a documentação do SDK.

Java

GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

AccessReview accessReview = new AccessReview();
accessReview.displayName = "TestReview";
accessReview.startDateTime = OffsetDateTimeSerializer.deserialize("2017-02-10T00:35:53.214Z");
accessReview.endDateTime = OffsetDateTimeSerializer.deserialize("2017-03-12T00:35:53.214Z");
Identity reviewedEntity = new Identity();
reviewedEntity.id = "99025615-a0b1-47ec-9117-35377b10998b";
accessReview.reviewedEntity = reviewedEntity;
accessReview.reviewerType = "delegated";
accessReview.businessFlowTemplateId = "6e4f3d20-c5c3-407f-9695-8460952bcc68";
accessReview.description = "Sample description";
LinkedList<AccessReviewReviewer> reviewersList = new LinkedList<AccessReviewReviewer>();
AccessReviewReviewer reviewers = new AccessReviewReviewer();
reviewers.id = "f260246a-09b1-4fd5-8d18-daed736071ec";
reviewersList.add(reviewers);
AccessReviewReviewer reviewers1 = new AccessReviewReviewer();
reviewers1.id = "5a4e184c-4ee5-4883-96e9-b371f8da88e3";
reviewersList.add(reviewers1);
AccessReviewReviewerCollectionResponse accessReviewReviewerCollectionResponse = new AccessReviewReviewerCollectionResponse();
accessReviewReviewerCollectionResponse.value = reviewersList;
AccessReviewReviewerCollectionPage accessReviewReviewerCollectionPage = new AccessReviewReviewerCollectionPage(accessReviewReviewerCollectionResponse, null);
accessReview.reviewers = accessReviewReviewerCollectionPage;
AccessReviewSettings settings = new AccessReviewSettings();
settings.mailNotificationsEnabled = true;
settings.remindersEnabled = true;
settings.justificationRequiredOnApproval = true;
settings.autoReviewEnabled = false;
settings.activityDurationInDays = 30;
settings.autoApplyReviewResultsEnabled = false;
settings.accessRecommendationsEnabled = false;
AccessReviewRecurrenceSettings recurrenceSettings = new AccessReviewRecurrenceSettings();
recurrenceSettings.recurrenceType = "onetime";
recurrenceSettings.recurrenceEndType = "endBy";
recurrenceSettings.durationInDays = 0;
recurrenceSettings.recurrenceCount = 0;
settings.recurrenceSettings = recurrenceSettings;
AutoReviewSettings autoReviewSettings = new AutoReviewSettings();
autoReviewSettings.notReviewedResult = "Deny";
settings.autoReviewSettings = autoReviewSettings;
accessReview.settings = settings;

graphClient.accessReviews()
    .buildRequest()
    .post(accessReview);

Importante

Os SDKs do Microsoft Graph usam a versão v1.0 da API por padrão e não dão suporte a todos os tipos, propriedades e APIs disponíveis na versão beta. Para obter detalhes sobre como acessar a API beta com o SDK, consulte Usar os SDKs do Microsoft Graph com a API beta.

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider , consulte a documentação do SDK.

Go

//THE GO SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
graphClient := msgraphsdk.NewGraphServiceClient(requestAdapter)

requestBody := msgraphsdk.NewAccessReview()
displayName := "TestReview"
requestBody.SetDisplayName(&displayName)
startDateTime, err := time.Parse(time.RFC3339, "2017-02-10T00:35:53.214Z")
requestBody.SetStartDateTime(&startDateTime)
endDateTime, err := time.Parse(time.RFC3339, "2017-03-12T00:35:53.214Z")
requestBody.SetEndDateTime(&endDateTime)
reviewedEntity := msgraphsdk.NewIdentity()
requestBody.SetReviewedEntity(reviewedEntity)
id := "99025615-a0b1-47ec-9117-35377b10998b"
reviewedEntity.SetId(&id)
reviewerType := "delegated"
requestBody.SetReviewerType(&reviewerType)
businessFlowTemplateId := "6e4f3d20-c5c3-407f-9695-8460952bcc68"
requestBody.SetBusinessFlowTemplateId(&businessFlowTemplateId)
description := "Sample description"
requestBody.SetDescription(&description)
requestBody.SetReviewers( []AccessReviewReviewer {
    msgraphsdk.NewAccessReviewReviewer(),
id := "f260246a-09b1-4fd5-8d18-daed736071ec"
    SetId(&id)
    msgraphsdk.NewAccessReviewReviewer(),
id := "5a4e184c-4ee5-4883-96e9-b371f8da88e3"
    SetId(&id)
}
settings := msgraphsdk.NewAccessReviewSettings()
requestBody.SetSettings(settings)
mailNotificationsEnabled := true
settings.SetMailNotificationsEnabled(&mailNotificationsEnabled)
remindersEnabled := true
settings.SetRemindersEnabled(&remindersEnabled)
justificationRequiredOnApproval := true
settings.SetJustificationRequiredOnApproval(&justificationRequiredOnApproval)
autoReviewEnabled := false
settings.SetAutoReviewEnabled(&autoReviewEnabled)
activityDurationInDays := int32(30)
settings.SetActivityDurationInDays(&activityDurationInDays)
autoApplyReviewResultsEnabled := false
settings.SetAutoApplyReviewResultsEnabled(&autoApplyReviewResultsEnabled)
accessRecommendationsEnabled := false
settings.SetAccessRecommendationsEnabled(&accessRecommendationsEnabled)
recurrenceSettings := msgraphsdk.NewAccessReviewRecurrenceSettings()
settings.SetRecurrenceSettings(recurrenceSettings)
recurrenceType := "onetime"
recurrenceSettings.SetRecurrenceType(&recurrenceType)
recurrenceEndType := "endBy"
recurrenceSettings.SetRecurrenceEndType(&recurrenceEndType)
durationInDays := int32(0)
recurrenceSettings.SetDurationInDays(&durationInDays)
recurrenceCount := int32(0)
recurrenceSettings.SetRecurrenceCount(&recurrenceCount)
autoReviewSettings := msgraphsdk.NewAutoReviewSettings()
settings.SetAutoReviewSettings(autoReviewSettings)
notReviewedResult := "Deny"
autoReviewSettings.SetNotReviewedResult(&notReviewedResult)
result, err := graphClient.AccessReviews().Post(requestBody)

Importante

Os SDKs do Microsoft Graph usam a versão v1.0 da API por padrão e não dão suporte a todos os tipos, propriedades e APIs disponíveis na versão beta. Para obter detalhes sobre como acessar a API beta com o SDK, consulte Usar os SDKs do Microsoft Graph com a API beta.

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider , consulte a documentação do SDK.

PowerShell

Import-Module Microsoft.Graph.Identity.Governance

$params = @{
    DisplayName = "TestReview"
    StartDateTime = [System.DateTime]::Parse("2017-02-10T00:35:53.214Z")
    EndDateTime = [System.DateTime]::Parse("2017-03-12T00:35:53.214Z")
    ReviewedEntity = @{
        Id = "99025615-a0b1-47ec-9117-35377b10998b"
    }
    ReviewerType = "delegated"
    BusinessFlowTemplateId = "6e4f3d20-c5c3-407f-9695-8460952bcc68"
    Description = "Sample description"
    Reviewers = @(
        @{
            Id = "f260246a-09b1-4fd5-8d18-daed736071ec"
        }
        @{
            Id = "5a4e184c-4ee5-4883-96e9-b371f8da88e3"
        }
    )
    Settings = @{
        MailNotificationsEnabled = $true
        RemindersEnabled = $true
        JustificationRequiredOnApproval = $true
        AutoReviewEnabled = $false
        ActivityDurationInDays = 30
        AutoApplyReviewResultsEnabled = $false
        AccessRecommendationsEnabled = $false
        RecurrenceSettings = @{
            RecurrenceType = "onetime"
            RecurrenceEndType = "endBy"
            DurationInDays = 0
            RecurrenceCount = 0
        }
        AutoReviewSettings = @{
            NotReviewedResult = "Deny"
        }
    }
}

New-MgAccessReview -BodyParameter $params

Importante

Os SDKs do Microsoft Graph usam a versão v1.0 da API por padrão e não dão suporte a todos os tipos, propriedades e APIs disponíveis na versão beta. Para obter detalhes sobre como acessar a API beta com o SDK, consulte Usar os SDKs do Microsoft Graph com a API beta.

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider , consulte a documentação do SDK.

Resposta

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

HTTP/1.1 201 Created
Content-type: application/json

{
    "id": "006111db-0810-4494-a6df-904d368bd81b",
    "displayName": "TestReview",
    "startDateTime": "2017-02-10T00:35:53.214Z",
    "endDateTime": "2017-03-12T00:35:53.214Z",
    "status": "Initializing",
    "businessFlowTemplateId": "6e4f3d20-c5c3-407f-9695-8460952bcc68",
    "reviewerType": "delegated",
    "description": "Sample description"
}