KB308816: How to List All of the Enabled Users in the Metadata Using MicroStrategy Web SDK 10.4

In Command Manager, the list of enabled users in the metadata is returned by the following command:

LIST LOGIN, ENABLED FOR USERS IN GROUP "Everyone";

 

This can also be done using Strategy Web SDK 10.4.  To list all enabled users is the everyone group, here is sample code:

import java.util.Enumeration;
import com.Strategy.web.objects.WebIServerSession;
import com.Strategy.web.objects.WebObjectInfo;
import com.Strategy.web.objects.WebObjectSource;
import com.Strategy.web.objects.WebObjectsException;
import com.Strategy.web.objects.WebObjectsFactory;
import com.Strategy.web.objects.admin.users.WebUser;
import com.Strategy.web.objects.admin.users.WebUserGroup;
import com.Strategy.web.objects.admin.users.WebUserList;
import com.Strategy.webapi.EnumDSSXMLApplicationType;
import com.Strategy.webapi.EnumDSSXMLObjectTypes;

public class ListAllEnabledMDUsers {
  public static WebObjectsFactory factory = null;
  public static WebIServerSession serverSession = null;
  public static WebObjectSource objectSource = null;

  public static void main(String[] args) {

        // Create factory object and object source.
        factory = WebObjectsFactory.getInstance();
        serverSession = factory.getIServerSession();
        objectSource = factory.getObjectSource();

        // Setting up Session information
        serverSession.setServerName("SERVER NAME");
        serverSession.setServerPort(0);
        serverSession.setProjectName("PROJECT NAME");
        serverSession.setLogin("USERNAME");
        serverSession.setPassword("USER PASSWORD");
        serverSession.setApplicationType(EnumDSSXMLApplicationType.DssXmlApplicationCustomApp);

        try {
 
           // Retrieve and populate the everyone user group object 
           WebObjectInfo woi = objectSource.getObject("Everyone-GUID" ,EnumDSSXMLObjectTypes.DssXmlTypeUser);
 
           woi.populate();

           // User group object
           WebUserGroup group = (WebUserGroup) woi;

           // Retrieving all users in the Everyone group
           WebUserList members = group.getMembers();
           Enumeration userEnum = members.elements();

           //WebUser object
           WebUser user = null;

           while(userEnum.hasMoreElements()){
             user = (WebUser) userEnum.nextElement();
             System.out.println("User member = " + user.getName() + 
             " enabled: " + user.isEnabled());
           }
        }
            
        } catch (WebObjectsException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        } catch (IllegalArgumentException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }

    }
}

The example provided in this document is provided “as-is” and user has read the following customization warning:
ADDITIONAL INFORMATION:
The Strategy SDK allows you to customize several Strategy products and extend and integrate the Strategy business intelligence functionality into other applications. However, before changing the way Strategy products look or behave, it is helpful to understand how the application is built. For more information regarding the Strategy products or the process of customizing Strategy products, please refer to Strategy Developer Zone (https://developer.microstrategy.com).
To access the Strategy Developer Zone, you must have access to the Strategy Knowledge Base, you must have purchased the Strategy SDK, and you must be current on your Strategy maintenance agreement. If you are a US-based business and believe that you satisfy all three of these conditions but you do not have access to the Strategy Developer Zone, please contact Strategy Technical Support at support@microstrategy.com or at (703) 848-8700. If you are an international business, please contact Strategy Technical Support at the appropriate email address or phone number found at https://www.microstrategy.com/us/services/support/contact.
CUSTOMIZATION WARNING:
This customization is provided as a convenience to Strategy users and is only directly applicable to the version stated. While this code may apply to other releases directly, Strategy Technical Support makes no guarantees that the code provided will apply to any future or previous builds. In the event of a code change in future builds, Strategy Technical Support makes no guarantee that an updated version of this particular customization will be provided. In the event of a code change in future builds, Strategy may not be able to provide additional code on this matter even though this customization is provided at this time for this specific build. For enhancements to this customization or to incorporate similar functionality into other versions, contact your Account Executive to inquire about Strategy Consulting assistance.