Update endUserSettings

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.

Update the properties of an endUserSettings object that controls the end user experience for access package suggestions and resource discovery.

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)	EntitlementManagement.ReadWrite.All	Not available.
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	EntitlementManagement.ReadWrite.All	Not available.

Tip

For delegated access using work or school accounts, the signed-in user must be assigned an administrator role with supported role permissions through one of the following options:

• A Microsoft Entra role where the least privileged role is Identity Governance Administrator. This is the least privileged option.

For more information, see Delegation and roles in entitlement management and how to delegate access governance to access package managers in entitlement management.

HTTP request

PUT /identityGovernance/entitlementManagement/controlConfigurations/endUserSettings

Request headers

Name	Description
Authorization	Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type	application/json. Required.

Request body

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

The following table shows the properties that are required when you update the endUserSettings.

Property	Type	Description
relatedPeopleInsightLevel	accessPackageSuggestionRelatedPeopleInsightLevel	The level of related people insights to show in access package suggestions. The possible values are: disabled, count, countAndNames, unknownFutureValue.
showApproverDetailsToMembers	Boolean	Indicates whether approver details are shown to members. When true, approver information is visible to members.

Response

If successful, this method returns a 200 OK response code and an updated endUserSettings object in the response body.

Examples

Request

The following example shows a request.

HTTP

PUT https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/controlConfigurations/endUserSettings
Content-type: application/json

{
  "@odata.type": "#microsoft.graph.endUserSettings",
  "relatedPeopleInsightLevel": "countAndNames",
  "showApproverDetailsToMembers": true
}

C#

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

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

var requestBody = new EndUserSettings
{
	OdataType = "#microsoft.graph.endUserSettings",
	RelatedPeopleInsightLevel = AccessPackageSuggestionRelatedPeopleInsightLevel.CountAndNames,
	ShowApproverDetailsToMembers = true,
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.IdentityGovernance.EntitlementManagement.ControlConfigurations["{controlConfiguration-id}"].PutAsync(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.

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.NewControlConfiguration()
relatedPeopleInsightLevel := graphmodels.COUNTANDNAMES_ACCESSPACKAGESUGGESTIONRELATEDPEOPLEINSIGHTLEVEL 
requestBody.SetRelatedPeopleInsightLevel(&relatedPeopleInsightLevel) 
showApproverDetailsToMembers := true
requestBody.SetShowApproverDetailsToMembers(&showApproverDetailsToMembers) 

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
controlConfigurations, err := graphClient.IdentityGovernance().EntitlementManagement().ControlConfigurations().ByControlConfigurationId("controlConfiguration-id").Put(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);

EndUserSettings controlConfiguration = new EndUserSettings();
controlConfiguration.setOdataType("#microsoft.graph.endUserSettings");
controlConfiguration.setRelatedPeopleInsightLevel(AccessPackageSuggestionRelatedPeopleInsightLevel.CountAndNames);
controlConfiguration.setShowApproverDetailsToMembers(true);
ControlConfiguration result = graphClient.identityGovernance().entitlementManagement().controlConfigurations().byControlConfigurationId("{controlConfiguration-id}").put(controlConfiguration);

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 controlConfiguration = {
  '@odata.type': '#microsoft.graph.endUserSettings',
  relatedPeopleInsightLevel: 'countAndNames',
  showApproverDetailsToMembers: true
};

await client.api('/identityGovernance/entitlementManagement/controlConfigurations/endUserSettings')
	.version('beta')
	.put(controlConfiguration);

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\EndUserSettings;
use Microsoft\Graph\Beta\Generated\Models\AccessPackageSuggestionRelatedPeopleInsightLevel;


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

$requestBody = new EndUserSettings();
$requestBody->setOdataType('#microsoft.graph.endUserSettings');
$requestBody->setRelatedPeopleInsightLevel(new AccessPackageSuggestionRelatedPeopleInsightLevel('countAndNames'));
$requestBody->setShowApproverDetailsToMembers(true);

$result = $graphServiceClient->identityGovernance()->entitlementManagement()->controlConfigurations()->byControlConfigurationId('controlConfiguration-id')->put($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 = @{
	"@odata.type" = "#microsoft.graph.endUserSettings"
	relatedPeopleInsightLevel = "countAndNames"
	showApproverDetailsToMembers = $true
}

Set-MgBetaEntitlementManagementControlConfiguration -ControlConfigurationId $controlConfigurationId -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.end_user_settings import EndUserSettings
from msgraph_beta.generated.models.access_package_suggestion_related_people_insight_level import AccessPackageSuggestionRelatedPeopleInsightLevel
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = EndUserSettings(
	odata_type = "#microsoft.graph.endUserSettings",
	related_people_insight_level = AccessPackageSuggestionRelatedPeopleInsightLevel.CountAndNames,
	show_approver_details_to_members = True,
)

result = await graph_client.identity_governance.entitlement_management.control_configurations.by_control_configuration_id('controlConfiguration-id').put(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

The following example shows the response.

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

HTTP/1.1 200 OK
Content-type: application/json

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/entitlementManagement/controlConfigurations/endUserSettings",
  "relatedPeopleInsightLevel": "countAndNames",
  "showApproverDetailsToMembers": true
}