Application Programming Interface Guide > Web Services Operations > Operations Reference > getDomainUsers
 
getDomainUsers
Get all of the user definitions within a domain.
If the scope is LOCAL_ONLY, only the users the server has local definitions for are returned. If the scope is ALL, all users are returned. For locally defined domains like the composite domain, both options return the same list. For domains with external storage, such as LDAP, only some of the users in the external storage may have been created as local users, so the returned lists may be different.
Location
/services/webservices/system/admin/user/operations/
Request Elements
domainName: The domain name.
scope: Either LOCAL_ONLY or ALL.
Response Elements
users: List of users within the domain.
user: The name, domain name and ID of a user, plus:
explicitRights. For a table of values, see User and Group Rights Mask.
interitedRights. For a table of values, see User and Group Rights Mask.
annotation (optional)
groupNames (optional): Names and domains of the groups to which the user belongs.
Faults
IllegalArgument: If an invalid scope is provided.
NotFound: If the domain does not exist.
Security: If the user does not have the ACCESS_TOOLS and READ_ALL_USERS rights.