- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- Examples
- Try it!
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.
HTTP request
PATCH https://privilegedaccessmanager.googleapis.com/v1/{entitlement.name=projects/*/locations/*/entitlements/*}
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
entitlement.name |
Identifier. Name of the entitlement. Possible formats:
|
Query parameters
Parameters | |
---|---|
updateMask |
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 a This is a comma-separated list of fully qualified names of fields. Example: |
Request body
The request body contains an instance of Entitlement
.
Response body
If successful, the response body contains an instance of Operation
.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
IAM Permissions
Requires the following IAM permission on the name
resource:
privilegedaccessmanager.entitlements.update
For more information, see the IAM documentation.