GetRoleUsers

Description

This services returns a list of users that are granted a particular role in a specified project.

Arguments

Argument	Type	Description
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.

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.

Usage

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:

multiOption – Enables you to specify whether the service should continue if an error is encountered, or stop and throw an error. If any failures occur, each successive error message is appended to the string that is returned. Multiple error messages are separated by a single newline. Failures do not result in a return before all users have been processed.
sections and specifiedSections – Enables you to specify which parts of a user record should be returned. This allows you to limit the data that is returned for a given user. The sections that aren't specified are not included in the response. For example, if you only need basic user information in the response, use the sections parameter to return only the STANDARD section.

For more information on the options elements, see UserResponseOptions.

Faults

Invalid parameter passed
User does not have privileges to view user
Role not found
Project not found

XML

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>