Create programControl (deprecated)

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Caution

This version of the access review API is deprecated and will stop returning data on May 19, 2023. Please use access reviews API.

In the Microsoft Entra access reviews feature, create a new programControl object. This links an access review to a program.

Prior to making this request, the caller must have previously

• created a program or retrieved a program, to have the value of programId to include in the request,
• created an access review or retrieved an access review, to have the value of controlId to include in the request, and
• retrieved the list of program control types, to have the value of controlTypeId to include in the request.

This API is available in the following national cloud deployments.

Global service	US Government L4	US Government L5 (DOD)	China operated by 21Vianet
✅	✅	✅	✅

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type	Least privileged permissions	Higher privileged permissions
Delegated (work or school account)	ProgramControl.ReadWrite.All	Not available.
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	ProgramControl.ReadWrite.All	Not available.

The signed in user must also be in a directory role that permits them to create a programControl.

HTTP request

POST /programControls

Request headers

Name	Type	Description
Authorization	string	Bearer {token}. Required.

Request body

In the request body, supply a JSON representation of a programControl object.

The following table shows the properties that are required when you create a program control.

Property	Type	Description
programId	String	The programId of the program this control is going to become a part of.
controlId	String	The controlId of the control, in particular the identifier of an access review.
controlTypeId	String	The programControlType identifies the type of program control - for example, a control linking to guest access reviews.

Response

If successful, this method returns a 201, Created response code and a programControl object in the response body.

Example

Request

In the request body, supply a JSON representation of the programControl object.

HTTP

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

{
    "controlId": "7e59d237-2fb0-4e5d-b7bb-d4f9f9129213",
    "controlTypeId": "6e4f3d20-c5c3-407f-9695-8460952bcc68",
    "programId": "7e59d237-2fb0-4e5d-b7bb-d4f9f9129213"
}

C#

// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Beta.Models;

var requestBody = new ProgramControl
{
	ControlId = "7e59d237-2fb0-4e5d-b7bb-d4f9f9129213",
	ControlTypeId = "6e4f3d20-c5c3-407f-9695-8460952bcc68",
	ProgramId = "7e59d237-2fb0-4e5d-b7bb-d4f9f9129213",
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.ProgramControls.PostAsync(requestBody);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

CLI

mgc-beta program-controls create --body '{\
    "controlId": "7e59d237-2fb0-4e5d-b7bb-d4f9f9129213",\
    "controlTypeId": "6e4f3d20-c5c3-407f-9695-8460952bcc68",\
    "programId": "7e59d237-2fb0-4e5d-b7bb-d4f9f9129213"\
}\
'

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Go

// Code snippets are only available for the latest major version. Current major version is $v0.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
	  //other-imports
)

requestBody := graphmodels.NewProgramControl()
controlId := "7e59d237-2fb0-4e5d-b7bb-d4f9f9129213"
requestBody.SetControlId(&controlId) 
controlTypeId := "6e4f3d20-c5c3-407f-9695-8460952bcc68"
requestBody.SetControlTypeId(&controlTypeId) 
programId := "7e59d237-2fb0-4e5d-b7bb-d4f9f9129213"
requestBody.SetProgramId(&programId) 

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
programControls, err := graphClient.ProgramControls().Post(context.Background(), requestBody, nil)

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Java

// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

ProgramControl programControl = new ProgramControl();
programControl.setControlId("7e59d237-2fb0-4e5d-b7bb-d4f9f9129213");
programControl.setControlTypeId("6e4f3d20-c5c3-407f-9695-8460952bcc68");
programControl.setProgramId("7e59d237-2fb0-4e5d-b7bb-d4f9f9129213");
ProgramControl result = graphClient.programControls().post(programControl);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const programControl = {
    controlId: '7e59d237-2fb0-4e5d-b7bb-d4f9f9129213',
    controlTypeId: '6e4f3d20-c5c3-407f-9695-8460952bcc68',
    programId: '7e59d237-2fb0-4e5d-b7bb-d4f9f9129213'
};

await client.api('/programControls')
	.version('beta')
	.post(programControl);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

PHP

<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\ProgramControl;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new ProgramControl();
$requestBody->setControlId('7e59d237-2fb0-4e5d-b7bb-d4f9f9129213');
$requestBody->setControlTypeId('6e4f3d20-c5c3-407f-9695-8460952bcc68');
$requestBody->setProgramId('7e59d237-2fb0-4e5d-b7bb-d4f9f9129213');

$result = $graphServiceClient->programControls()->post($requestBody)->wait();

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

PowerShell

Import-Module Microsoft.Graph.Beta.Identity.Governance

$params = @{
	controlId = "7e59d237-2fb0-4e5d-b7bb-d4f9f9129213"
	controlTypeId = "6e4f3d20-c5c3-407f-9695-8460952bcc68"
	programId = "7e59d237-2fb0-4e5d-b7bb-d4f9f9129213"
}

New-MgBetaProgramControl -BodyParameter $params

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Python

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.models.program_control import ProgramControl
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = ProgramControl(
	control_id = "7e59d237-2fb0-4e5d-b7bb-d4f9f9129213",
	control_type_id = "6e4f3d20-c5c3-407f-9695-8460952bcc68",
	program_id = "7e59d237-2fb0-4e5d-b7bb-d4f9f9129213",
)

result = await graph_client.program_controls.post(request_body)

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

Note: The response object shown here might be shortened for readability.

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

{
  "id": "63b2302c-7e62-43b7-aefb-063ba5bdb853",
  "controlId": "7e59d237-2fb0-4e5d-b7bb-d4f9f9129213",
  "programId": "7e59d237-2fb0-4e5d-b7bb-d4f9f9129213",
  "controlTypeId": "6e4f3d20-c5c3-407f-9695-8460952bcc68",
  "displayName": "test",
  "status": "Active",
  "createdDateTime": "2018-05-18T20:26:05.2976279Z"
}

Related content

Method	Return Type	Description
List programControlTypes	programControlType collection	List program control types.