Web Services Developer's Guide → Web Services API Reference → SBM Administrative Web Services → Administrative Calls → GetRoleUsers
This services returns a list of users that are granted a particular role in a specified project.
|auth (optional)||Auth||The Auth type supplies credentials and optionally, a host name for licensing. The userId and password can be specified with HTTP BASIC or WS-SECURITY instead.|
|role||RoleIdentifier||Indicates the role that is used to find users.|
|options||UserResponseOptions||Specifies whether the service should continue if an error is encountered or stop. Also enables you to limit the data that is returned in the response.|
UserHolder is returned. The UserHolder response contains one or more UserIdentifiers and additional information from the users preferences. For more specific information, see UserHolder.
The RoleIdentifier uniquely identifies the role. You must specify a project in the RoleIdentifier in order to return users. If an invalid role or no role is specified at all, the call will succeed, but no user information will be returned.
Use the following elements in the options parameter to control how this call is processed and what data is returned:
For more information on the options elements, see UserResponseOptions.
The following XML is a snippet of the payload that is sent with GetRoleUsers.
<urn:GetRoleUsers> <urn:auth> <urn:userId>admin</urn:userId> </urn:auth> <urn:role> <urn:displayName>IM Manager</urn:displayName> <urn:projectId> <urn:displayName>IM Project</urn:displayName> </urn:projectId> </urn:role> <urn:options> <urn:sections>SECTIONS-NONE</urn:sections> </urn:options> </urn:GetRoleUsers>
Copyright © 2007–2015 Serena Software, Inc. All rights reserved.