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 an existing accessPackageSubject object to change the subject lifecycle.
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) |
EntitlementManagement.ReadWrite.All |
Not available. |
| Delegated (personal Microsoft account) |
Not supported. |
Not supported. |
| Application |
EntitlementManagement.ReadWrite.All |
Not available. |
HTTP request
PATCH /identityGovernance/entitlementManagement/subjects(objectId='{objectIdOfUser}')
Request body
In the request body, supply only the values for properties to update. Existing properties that aren't included in the request body maintain their previous values or are recalculated based on changes to other property values.
The following table specifies the properties that can be updated.
| Property |
Type |
Description |
| subjectLifecycle |
accessPackageSubjectLifecycle |
The lifecycle of the subject user, if a guest. The possible values are: notDefined, notGoverned, governed. |
Response
If successful, this method returns a 204 No Content response code.
Examples
Request
PATCH https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/subjects(objectId='{objectIdOfUser}')
Content-Type: application/json
{
"subjectLifecycle":"governed"
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.Models;
var requestBody = new AccessPackageSubject
{
SubjectLifecycle = AccessPackageSubjectLifecycle.Governed,
};
// 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.SubjectsWithObjectId("{objectId}").PatchAsync(requestBody);
mgc-beta identity-governance entitlement-management subjects-with-object-id patch --object-id {object-id} --body '{\
"subjectLifecycle":"governed"\
}\
'
// 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.NewAccessPackageSubject()
subjectLifecycle := graphmodels.GOVERNED_ACCESSPACKAGESUBJECTLIFECYCLE
requestBody.SetSubjectLifecycle(&subjectLifecycle)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
objectId := "{objectId}"
subjects, err := graphClient.IdentityGovernance().EntitlementManagement().SubjectsWithObjectId(&objectId).Patch(context.Background(), requestBody, nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
AccessPackageSubject accessPackageSubject = new AccessPackageSubject();
accessPackageSubject.setSubjectLifecycle(AccessPackageSubjectLifecycle.Governed);
AccessPackageSubject result = graphClient.identityGovernance().entitlementManagement().subjectsWithObjectId("{objectId}").patch(accessPackageSubject);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\AccessPackageSubject;
use Microsoft\Graph\Beta\Generated\Models\AccessPackageSubjectLifecycle;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new AccessPackageSubject();
$requestBody->setSubjectLifecycle(new AccessPackageSubjectLifecycle('governed'));
$result = $graphServiceClient->identityGovernance()->entitlementManagement()->subjectsWithObjectId('{objectId}', )->patch($requestBody)->wait();
Import-Module Microsoft.Graph.Beta.Identity.Governance
$params = @{
subjectLifecycle = "governed"
}
Update-MgBetaEntitlementManagementSubjectByObjectId -BodyParameter $params -ObjectId $objectIdId
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.models.access_package_subject import AccessPackageSubject
from msgraph_beta.generated.models.access_package_subject_lifecycle import AccessPackageSubjectLifecycle
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = AccessPackageSubject(
subject_lifecycle = AccessPackageSubjectLifecycle.Governed,
)
result = await graph_client.identity_governance.entitlement_management.subjects_with_object_id("{objectId}").patch(request_body)
Response
HTTP/1.1 204 No Content