RoleInfo

Description

The RoleInfo type holds the name and assignment information about roles for users and groups. The RoleInfo type parameters are listed below.

Parameters

Name Type Description
id RoleIdentifier Holds the complete identification information and associated project for a role.
access GrantState Enumeration element that holds role assignment information.
extendedData ExtendedData Placeholder for future arguments.

Usage

The RoleInfo type contains the role name and how the role is currently assigned. The GetUserRoles and GetGroupRoles calls return lists of RoleInfo records that are assigned to particular users or groups.

XML

The following XML shows RoleInfo as seen in the <urn:role> element in a typical call.

<urn:SetGroupRoles>
    <urn:auth>
        <urn:userId>bill</urn:userId>
        <urn:password>sa</urn:password>
        <urn:hostname>localhost</urn:hostname>
    </urn:auth>
    <urn:group>
        <urn:displayName>IDM View Only</urn:displayName>
    </urn:group>
    <urn:role>
        <urn:id>
            <urn:displayName>IDM Team</urn:displayName>
            <urn:projectId>
                <urn:displayName>IDM Project</urn:displayName>
            </urn:projectId>
        </urn:id>
        <urn:access>GRANTED</urn:access>
    </urn:role>
    <urn:role>
        <urn:id>
            <urn:displayName>IDM Administrator</urn:displayName>
            <urn:projectId>
                <urn:displayName>IDM Project</urn:displayName>
            </urn:projectId>
        </urn:id>
        <urn:access>INHERITED</urn:access>
     </urn:role>
</urn:SetGroupRoles>