GetGroupRoles

Description

This services returns a list of roles for a specified group.

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.
group	GroupIdentifier	Indicates the group for which roles should be returned.
project	ProjectIdentifier	Indicates the project.

Response

One or more RoleHolder responses are returned. The roles are returned in the context of the specified group. The role name, type, and assignment information are returned. For more information, see RoleHolder.

Usage

The <urn:group> parameter uniquely identifies the group. Providing the <urn:projectId> value in the GroupIdentifier improves performance of the call, especially for the systems with several projects.

If an invalid role or no role is specified at all, the call will succeed, but no role information will be returned.

Faults

The user lacks sufficient privileges to view the group.

XML

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

<urn:GetGroupRoles>
    <urn:auth>
        <urn:userId>bill</urn:userId>
        <urn:password></urn:password>
        <urn:hostname></urn:hostname>
    </urn:auth>
    <urn:group>
        <urn:displayName>IDM View Only</urn:displayName>
    </urn:group>
    <urn:project>
        <urn:displayName>IDM Project</urn:displayName>
    </urn:project>
</urn:GetGroupRoles>