Skip to main content

Entitlementmetadatabulkupdatebyqueryrequest

Request to bulk update Access Model Metadata on every entitlement matching a search query. Adding or replacing custom metadata requires a suite license. For more information about the query object, refer to V3 API Perform Search.

Properties

NameTypeDescriptionNotes
queryobjectThe search query selecting the entitlements to update.[required]
operationEnum [ 'ADD', 'REMOVE', 'REPLACE' ]The operation to be performed[required]
replace_scopeEnum [ 'ALL', 'ATTRIBUTE' ]The choice of update scope. ATTRIBUTE replaces only the values of the attributes named in values, and ALL replaces every metadata attribute on the entitlement.[optional]
values[]EntitlementmetadatabulkupdatebyidrequestValuesInnerThe metadata to be updated, including attribute key and value.[required]
}

Example

from sailpoint.entitlements.models.entitlementmetadatabulkupdatebyqueryrequest import Entitlementmetadatabulkupdatebyqueryrequest

entitlementmetadatabulkupdatebyqueryrequest = Entitlementmetadatabulkupdatebyqueryrequest(
query={"indices":["entitlements"],"queryType":"TEXT","textQuery":{"terms":["test123"],"fields":["id"],"matchAny":false,"contains":true},"includeNested":false},
operation='REPLACE',
replace_scope='ATTRIBUTE',
values=[{"attribute":"iscFederalClassifications","values":["topSecret"]}]
)

[Back to top]