PermissionSetTabSetting
Represents a tab’s settings for a profile or permission set. Use PermissionSetTabSetting for manipulating tab visibility on profiles and permission sets.
Introduced in API version 37.0.
create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()
DELETE, GET, HEAD, PATCH, POST, Query
- As of Spring ’20 and later, only users with View Setup and Configuration permission can access this object.
-
Type: string
-
Required: No
-
Properties: Create, Filter, Group, Sort
-
Description: The tab’s API name. For standard tabs, the name is in the form “standard-Account”. For custom tabs, it’s the developer name.
-
Type: reference
-
Required: No
-
Properties: Create, Filter, Group, Sort
-
Description: The ID of the permission set to which this tab setting belongs. For profile tab settings,
ParentIdis the ID of the permission set owned by the profile. -
Relationship name: Parent
-
Relationship type: polymorphic
-
Refers to: MutingPermissionSet, PermissionSet
-
Type: picklist
-
Required: No
-
Properties: Create, Filter, Group, Restricted picklist, Sort, Update
-
Description: The default visibility setting for this tab. Valid values are:
-
Default Off
-
Default On
-
Possible values:
-
DefaultOff — Default Off
-
DefaultOn — Default On
There’s no hidden value. Instead, a hidden tab is indicated by having no
PermissionSetTabSettingrow in the database. -
To hide a tab, delete the associated PermissionSetTabSetting object. ParentId and Name fields can’t be updated.
This example creates a tab setting to make the custom object tab named CustomObject__c visible for the System Administrator profile.
This example updates the existing tab setting to make the Account tab available instead of visible for the Standard User profile.
The example deletes the existing tab setting to make the Account tab hidden for the Standard User profile.