Updates the entitlement specified in the request. Updated fields in the entitlement need to be specified in an update mask. The changes made to an entitlement are applicable only on future grants of the entitlement. However, if new approvers are added or existing approvers are removed from the approval workflow, the changes are effective on existing grants.
The following fields are not supported for updates:
All immutable fields
Entitlement name
Resource name
Resource type
Adding an approval workflow in an entitlement which previously had no approval workflow.
Deleting the approval workflow from an entitlement.
Adding or deleting a step in the approval workflow (only one step is supported)
Note that updates are allowed on the list of approvers in an approval workflow step.
Required. The list of fields to update. A field is overwritten if, and only if, it is in the mask. Any immutable fields set in the mask are ignored by the server. Repeated fields and map fields are only allowed in the last position of apathsstring and overwrite the existing values. Hence an update to a repeated field or a map should contain the entire list of values. The fields specified in the updateMask are relative to the resource and not to the request. (e.g.MaxRequestDuration;notentitlement.MaxRequestDuration) A value of '*' for this field refers to full replacement of the resource.
This is a comma-separated list of fully qualified names of fields. Example:"user.displayName,photo".
Request body
The request body contains an instance ofEntitlement.
Response body
If successful, the response body contains an instance ofOperation.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-05-21 UTC."],[[["\u003cp\u003eThis page details how to update an entitlement, which involves specifying the fields to be modified via an update mask.\u003c/p\u003e\n"],["\u003cp\u003eThe HTTP request utilizes a \u003ccode\u003ePATCH\u003c/code\u003e method and requires a URL with gRPC Transcoding syntax, using the entitlement's name as a path parameter.\u003c/p\u003e\n"],["\u003cp\u003eQuery parameters include \u003ccode\u003eupdateMask\u003c/code\u003e, a field that dictates which specific fields within the entitlement should be overwritten during the update.\u003c/p\u003e\n"],["\u003cp\u003eThe request body should be filled with an \u003ccode\u003eEntitlement\u003c/code\u003e instance, while a successful response will contain an \u003ccode\u003eOperation\u003c/code\u003e instance.\u003c/p\u003e\n"],["\u003cp\u003eUpdating an entitlement requires the \u003ccode\u003eprivilegedaccessmanager.entitlements.update\u003c/code\u003e IAM permission and the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"]]],[],null,["# Method: folders.locations.entitlements.patch\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [IAM Permissions](#body.aspect_1)\n- [Examples](#examples)\n- [Try it!](#try-it)\n\nUpdates the entitlement specified in the request. Updated fields in the entitlement need to be specified in an update mask. The changes made to an entitlement are applicable only on future grants of the entitlement. However, if new approvers are added or existing approvers are removed from the approval workflow, the changes are effective on existing grants.\n\nThe following fields are not supported for updates:\n\n- All immutable fields\n- Entitlement name\n- Resource name\n- Resource type\n- Adding an approval workflow in an entitlement which previously had no approval workflow.\n- Deleting the approval workflow from an entitlement.\n- Adding or deleting a step in the approval workflow (only one step is supported)\n\nNote that updates are allowed on the list of approvers in an approval workflow step.\n\n### HTTP request\n\n`PATCH https://privilegedaccessmanager.googleapis.com/v1/{entitlement.name=folders/*/locations/*/entitlements/*}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Query parameters\n\n### Request body\n\nThe request body contains an instance of [Entitlement](/iam/docs/reference/pam/rest/v1/folders.locations.entitlements#Entitlement).\n\n### Response body\n\nIf successful, the response body contains an instance of [Operation](/iam/docs/reference/pam/rest/Shared.Types/ListOperationsResponse#Operation).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](https://cloud.google.com/docs/authentication/).\n\n### IAM Permissions\n\nRequires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource:\n\n- `privilegedaccessmanager.entitlements.update`\n\nFor more information, see the [IAM documentation](https://cloud.google.com/iam/docs)."]]
