UserAccessPolicyFilter

Represents a user criteria filter for a user access policy.

You can use the UserAccessPolicyFilter Tooling API object to configure more complex user criteria filters for your user access policies.

Version 

Introduced in API version 56.0.

Supported SOAP API Calls 

create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Supported REST API Methods 

DELETE, GET, HEAD, PATCH, POST, Query

Special Access Rules 

• To create or modify user access policies, users must have the Manage User Access Policies permission.

Fields 

ColumnName 

• Type: picklist

• Required: No

• Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update

• Description: If Target is set to User, the user field that your user criteria filter is based on.

Some custom fields are also supported, depending on the field type. If you don’t set Target to User, then this field isn’t used.

Operation 

• Type: picklist

• Required: No

• Properties: Create, Filter, Group, Restricted picklist, Sort, Update

• Description: The operator of the user criteria filter.

Select in if you want to reference multiple profile or role IDs in the same user criteria filter. To do this, create multiple UserAccessPolicyFilter objects with Operation set to in and with the same SortOrder value. The only field that differs between these UserAccessPolicyFilter objects is the Value field, which references the various IDs. All of the IDs referenced in the in expression must be of the same type.

• Possible values:

  • equals — Equals (Case Sensitive)

  • equalsIgnoreCase — Equals (Ignore Case) — Available in API version 59.0 and later.

  • notEquals — Not Equals

  • in — In — Available in API version 58.0 and later.

  • includes — Includes — Available in API version 59.0 and later.

SortOrder 

• Type: int

• Required: No

• Properties: Create, Filter, Group, Sort, Update

• Description: The numeric reference used to identify the specific filter.

Target 

• Type: picklist

• Required: No

• Properties: Create, Filter, Group, Restricted picklist, Sort, Update

• Description: If your user criteria filter is based on a user field, set to User. If your user criteria filter is based on a package license, permission set, permission set group, permission set license, profile, or role, then this field isn’t used.

UserAccessPolicyId 

• Type: reference

• Required: No

• Properties: Create, Filter, Group, Sort

• Relationship name: UserAccessPolicy

• Relationship type: masterdetail

• Refers to: UserAccessPolicy

Value 

• Type: string

• Required: No

• Properties: Create, Filter, Group, Nillable, Sort, Update

• Description: If Target is set to User, the value of the user field specified in ColumnName that your user filter is operating on. Otherwise, the ID of the group, package license, permission set, permission set group, permission set license, profile, role, or queue that your user filter is operating on.

Usage 

For more information, see User Access Policies in Salesforce Help.