GetRoleGroups

Description

This services returns a list of groups 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 groups.
options	MultipleOptions	Holds name value pairing for future elements and enumeration to determine if the service should stop on failure and send an error message, or continue processing.

Response

GroupHolder is returned. The GroupHolder response contains the GroupIdentifier and additional information about the group. For more specific information, see GroupHolder.

Usage

The RoleIdentifier uniquely identifies the role. You must specify a project in the RoleIdentifier in order to return groups. If an invalid role or no role is specified at all, the call will succeed, but no group information will be returned.

Faults

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

XML

The following XML is a snippet of the payload that is sent with GetRoleGroups.

<urn:GetRoleGroups>
    <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:multiOption>CONTINUE-ON-FAILURE</urn:multiOption>
    </urn:options>
</urn:GetRoleGroups>