[SalesForce] How to get list list of flows accessible by a User based on Permission Sets

In order to provide more granular and controlled access to flows, all our flows are enabled with access setting of "Override default behavior and restrict access to enabled profiles or permission sets" and access to the flows will be provisioned only using Permission Sets (Permission Set -> Flow Access settings).

We have a requirement to display the list of flows the user has access to based on the permission sets assigned to them. How can we achieve this using SOQL or Apex?

Best Answer

In short: I managed to do this in Apex by using apex-mdapi AFTER I updated the code to support flowAccesses. - here's the github commit with changes needed to support it. This is the only way I can see to do this through Apex as you need to hit the Metadata API.

Very Long Version

I didn't see anything within SOQL or Tooling API that can be used. It seems like it's only available with the Metadata API based on the simple fact that you can retrieve this information with the following package.xml

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">

This returns the following

<?xml version="1.0" encoding="UTF-8"?>
<PermissionSet xmlns="http://soap.sforce.com/2006/04/metadata">

That leaves you with trying to use Apex and the Metadata API. This isn't a supported type for what Salesforce provides access to through Apex. Likewise, I don't see any mention of flow access in the Metadata API Developer Guide which puzzled me. However, they do list the other naming conventions for other "access" types:


So now I looked towards apex-mdapi which does allow you to interact with apex/Metadata API

You can see the code/github here and this is a helpful answer with links to many questions concerning it. I had to make edits to it since it hasn't been updated since flowAccesses was brought into play. I used customMetadataTypeAccess (which is also relatively new) as a test since that one is at least documented in the developer guide.

You can see my changes in my forked repo and the latest commits contains all the changes needed for this in particular. Based on the naming convention in the developer guide (and testing that PermissionSetCustomMetadataTypeAccess[] worked first), I used PermissionSetFlowAccess[] and the example of the returned retrieve file to populate what the field names would be. You can see that the name of the flow is stored in <flow></flow>

So now, going off all that above...

Depending on when/where your code is executing, you'd probably first want to get a list of permission sets assigned to the user using SOQL. From this, you can see the following should do the trick

SELECT PermissionSet.Name FROM PermissionSetAssignment WHERE AssigneeId = 'User Name here'

Once you have a list of permission set names, you can call the Metadata API through the MetadataService you modified above to simply get those permission sets returned and loop through them to get a list of the Flows they have access to.

public class testmetadata {

    public static MetadataService.MetadataPort createService()
        MetadataService.MetadataPort service = new MetadataService.MetadataPort();
        service.SessionHeader = new MetadataService.SessionHeader_element();
        service.SessionHeader.sessionId = UserInfo.getSessionId();
        return service;     
    public static void testPerm()
        //presumably you'd pass this list based on the SOQL query
        String[] permissionSetNames = new String[] {'test', 'test2', 'test3'};

        String message = '';
        MetadataService.MetadataPort service = createService();
        List<MetadataService.PermissionSet> perm = (List<MetadataService.PermissionSet>) service.readMetadata('PermissionSet', permissionSetNames).getRecords();

        //loop through returned permission sets based on the names assigned to user
        for(MetadataService.PermissionSet permSet : perm){
            message = permSet.fullName + ' with access to the following flow(s): ';
            //loop through flows that are enabled for access in each perm set to display name
            for(MetadataService.PermissionSetFlowAccess singleFlow : permSet.flowAccesses){
               message += singleFlow.flow + ', ';

What I tested (using only 3 different flows):

  • Created 3 permission sets - test1, test2, test3
  • Gave test1 access to one flow
  • Gave test2 access to 2 flows
  • Gave test3 access to 3 flows

See the debug log returned below:

enter image description here

Update: Just to show that the assumptions I made above for the naming convention at least are now corroborated by info in the Metadata API WSDL. You can see the naming for Profile and Permission Set.

enter image description here

enter image description here

Related Topic