{"id":"sforce_api_objects_setupentityaccess","title":"SetupEntityAccess","content":"

SetupEntityAccess

\n
\nRepresents the enabled setup entity access settings (such as for Apex\n classes) for the parent PermissionSet. This object is available in API version 25.0\n and later.
\n\n

To grant users access to an entity, associate the appropriate SetupEntityAccess record with\n a PermissionSet that’s assigned to a user.

\n\n
\n

Supported Calls

\n\n \n

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

\n\n
\n\n
\n

Special Access Rules

\n\n \n

As of Spring ’20 and later, only users with \"View Setup and Configuration\" permission\n can access this object.

\n\n
\n\n
\n

Fields

\n\n \n \n
\n \n \n \n \n \n\n \n\n \n\n \n\n \n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n
Field NameDetails
ParentId\n
\n \n
Type
\n\n
reference
\n\n \n \n
Properties
\n\n
Create, Filter, Group, Sort
\n\n \n \n
Description
\n\n
The ID of the entity’s parent PermissionSet.
\n\n
This is a relationship field.
\n\n \n \n
Relationship Name
\n\n
Parent
\n\n \n \n
Relationship Type
\n\n
Lookup
\n\n \n \n
Refers To
\n\n
PermissionSet
\n\n \n
\n\n
SetupEntityId\n
\n \n
Type
\n\n
reference
\n\n \n \n
Properties
\n\n
Create, Filter, Group, Sort
\n\n \n \n
Description
\n\n
The ID of the entity for which access is enabled, such as an Apex\n class or Visualforce\n page.
\n\n \n
\n\n
SetupEntityType\n
\n \n
Type
\n\n
picklist
\n\n \n \n
Properties
\n\n
Filter, Group, Nillable, Restricted picklist, Sort
\n\n \n \n
Description
\n\n
The type of setup entity for which access is enabled. Valid values are:
    \n
  • \nApexClass for Apex classes
    • \n\n
  • \nApexPage for Visualforce pages
    • \n\n
  • In API version 64.0 and later,\n BotDefinition for agents
    • \n\n
  • In API version 28.0 and later,\n ConnectedApplication for OAuth\n connected apps
    • \n\n
  • In API version 48.0 and later,\n CustomEntityDefinition for Custom\n Settings and Custom Metadata Types
    • \n\n
  • In API version 31.0 and later,\n CustomPermission for custom\n permissions
    • \n\n
  • In API version 62.0 and later,\n EmailRoutingAddress for email routing\n addresses.
    • \n\n
  • In API version 60.0 and later,\n ExternalClientApplication for\n external client apps.
    • \n\n
  • In API version 58.0 and later,\n ExternalCredentialParameter for\n external credential principals.
    • \n\n
  • In API version 58.0 and later,\n FlowDefinition for flows
    • \n\n
  • In API version 62.0 and later,\n MessagingChannel for messaging\n channels
    • \n\n
  • In API version 58.0 and later,\n OrgWideEmailAddress for\n organization-wide email addresses
    • \n\n
  • In API version 28.0 and later,\n ServiceProvider for service\n providers
    • \n\n
  • In API version 60.0 and later,\n StandardInvocableActionType for\n standard invocable actions.
    • \n\n
  • In API version 28.0 and later, TabSet\n for apps
    • \n\n
\n
\n\n \n
\n\n
\n\n
\n\n
\n

Usage

\n\n \n

Because SetupEntityAccess is a child of the PermissionSet object, the usage is similar\n to other PermissionSet child objects like FieldPermissions and ObjectPermissions.

\n\n
For example, the following code returns all permission sets that grant access to any\n setup entities for which access is\n enabled:
SELECT Id, ParentId, Parent.Name, SetupEntityId\nFROM SetupEntityAccess
\n
\n\n
The following code returns permission sets that grant access only to Apex\n classes:
SELECT Id, ParentId, Parent.Name, SetupEntityId\nFROM SetupEntityAccess\nWHERE SetupEntityType='ApexClass'
\n
\n\n
The following code returns permission sets that grant access to any setup entities, and\n are not owned by a\n profile:
SELECT Id, ParentId, Parent.Name, SetupEntityId\nFROM SetupEntityAccess\nWHERE ParentId\nIN (SELECT Id\n   FROM PermissionSet\n   WHERE isOwnedByProfile = false)
\n
\n\n
You may want to return only those permission sets that have access to a specific setup\n entity. To do this, query the parent object. For example, this code returns all\n permission sets that grant access to the helloWorld Apex\n class:
SELECT Id, Name,\n   (SELECT Id, Parent.Name, Parent.Profile.Name\n   FROM SetupEntityAccessItems)\nFROM ApexClass\nWHERE Name = 'helloWorld'
\n
\n\n
While it’s possible to return permission sets that have access to a\n ConnectedApplication, ServiceProvider, or\n TabSet by SetupEntityId, it’s not possible\n to return permission sets that have access to these SetupEntityType\n fields by any other AppMenuItem attribute, such as Name or\n Description. For example, to find out if a user has access to\n the Recruiting app, you’d run two queries. First, query to get the AppMenuItem\n ID:
SELECT Id, Name, Label\nFROM AppMenuItem\nWHERE Name = 'Recruiting'
\n
\n\n
Let’s say the previous query returned the AppMenuItem ApplicationId\n 02uD0000000GIiMIAW. Using this ID, you can now run a query to find out if a user has\n access to the Recruiting\n app:
SELECT Id, SetupEntityId, SetupEntityType\nFROM SetupEntityAccess\nWHERE ParentId\nIN\n   (SELECT PermissionSetId \n   FROM PermissionSetAssignment\n   WHERE AssigneeId = '005D0000001QOzF')\nAND (SetupEntityId = '02uD0000000GIiMIAW')
\n
\n\n
\n\n
\n
\n

See Also

\n\n
\n
"}