HasGroupRole

Description

This service checks for a specified role by name.

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	The group to check against.
role	RoleIdentifier	The role to verify.

Response

A boolean is returned, showing whether the group has the role (true) or not (false). Either inherited or explicitly granted roles are taken into account. The role is checked in the context of the specified group. For example:

<ae:HasGroupRoleResponse>
   <ae:return>true</ae:return>
</ae:HasGroupRoleResponse>

Usage

You can call GetGroupRoles for a group to return a list of available roles. You can then use these roles in the HasGroupRole call.

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

Faults

Role not found.
Project not found.
The user lacks sufficient privileges to view the group.

XML

The following XML is a snippet of the payload this is sent with HasGroupRole.

<urn:HasGroupRole>
    <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:role>
        <urn:displayName>IDM Manager</urn:displayName>
        <urn:projectId>
            <urn:displayName>IDM Project</urn:displayName>
        </urn:projectId>
    </urn:role>
</urn:HasGroupRole>