UserAccessPolicyAction

Represents an action applied by the user access policy.

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 

Action 

• Type: picklist

• Required: No

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

• Description: Indicates whether the user access policy grants access to or removes access from the target access mechanism.

• Possible values:

  • Grant — Grant

  • Revoke — Revoke

TargetId 

• Type: reference

• Required: No

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

• Description: The ID of the access mechanism that the user access policy applies.

This field is a polymorphic relationship field.

• Relationship name: Target
• Relationship type: polymorphic
• Refers to: PermissionSet, PermissionSetLicense, PermissionSetGroup, PackageLicense, Group, Queue

UserAccessPolicyId 

• Type: reference

• Required: No

• Properties: Create, Filter, Group, Sort

• Relationship name: UserAccessPolicy

• Relationship type: masterdetail

• Refers to: UserAccessPolicy

Usage 

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