GetGroupPrivileges

Description

This services returns a list of privileges 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.
privilegeType string Indicates the privilege is either a normal user privilege or an administrator privilege. The types of privilege for each are listed below.
objectId (optional) string The ID of the object you wish to check privileges against. If provided, privilegeType becomes required.
group GroupIdentifier Indicates the group for which privileges should be returned.

Response

Privilege is returned. The privileges are returned in the context of the specified group. The privilege name, type, and object UUID (if the privilege applies only to a particular object like a project or table) are returned. For more information, see Privilege.

Usage

The objectId argument is used to limit the privilege check to a certain database object. For example, if want to query a table privilege, you specify the table ID of the table. If you want to query a project privilege, you specify the project ID. To check for system privileges, send an empty objectID argument. If the object ID is not composed of all numeric digits, the ID is interpreted as the UUID for the object. Note that if this parameter is provided, then the privilegeType argument is required.

If an invalid privilege type or no privilege type is specified at all, the call will succeed, but no privilege information will be returned. The tables below contain the possible privilege types.

The available privilege types for a normal user are:

TS_PRIVTYPE_USERSYS
TS_PRIVTYPE_USERPRJ
TS_PRIVTYPE_USERWKF
TS_PRIVTYPE_USERFLD
TS_PRIVTYPE_USERTBL

The available privilege types for an administrator are:

TS_PRIVTYPE_ADMSYS
TS_PRIVTYPE_ADMPRJ
TS_PRIVTYPE_ADMWKF
TS_PRIVTYPE_ADMFLD_PRJ
TS_PRIVTYPE_ADMFLD_WKF
TS_PRIVTYPE_ADMCON
TS_FLDPRIVTYPE_ADMFLD
TS_FLDPRIVTYPE_ADMGRP
TS_FLDPRIVTYPE_ADMTBL

Faults

XML

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

<urn:GetGroupPrivileges>
    <urn:auth>
        <urn:userId>bill</urn:userId>
        <urn:password>sa</urn:password>
        <urn:hostname>localhost</urn:hostname>
    </urn:auth>
    <urn:group>
        <urn:displayName>Everyone</urn:displayName>
    </urn:group>
    <urn:privilegeType>TS_PRIVTYPE_USERSYS</urn:privilegeType>
</urn:GetGroupPrivileges>