GetPrivilegeTypes

Description

This services returns the list of available privilege types.

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.
kind	PrivilegeKind	Determines if the privilege type is USER-KIND or ADMIN-KIND.

Response

A list of privilege types are returned, depending on the <urn:kind> you specify. For more information, see PrivilegeKind.

Usage

Use the types returned in GetPrivilegeTypes with the GetTypePrivileges call to return a list of privileges that exist for each privilege type.

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

None.

XML

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

<urn:GetPrivilegeTypes>
    <urn:auth>
        <urn:userId>bill</urn:userId>
        <urn:password></urn:password>
        <urn:hostname></urn:hostname>
    </urn:auth>
    <urn:kind>ADMIN-KIND</urn:kind>
</urn:GetPrivilegeTypes>

The response:

<ae:GetPrivilegeTypesResponse>
   <ae:return>TS_PRIVTYPE_ADMSYS</ae:return>
   <ae:return>TS_PRIVTYPE_ADMPRJ</ae:return>
   <ae:return>TS_PRIVTYPE_ADMWKF</ae:return>
   <ae:return>TS_PRIVTYPE_ADMFLD_PRJ</ae:return>
   <ae:return>TS_PRIVTYPE_ADMFLD_WKF</ae:return>
   <ae:return>TS_FLDPRIVTYPE_ADMFLD</ae:return>
   <ae:return>TS_FLDPRIVTYPE_ADMGRP</ae:return>
   <ae:return>TS_FLDPRIVTYPE_ADMTBL</ae:return>
   <ae:return>TS_PRIVTYPE_ADMCON</ae:return>
</ae:GetPrivilegeTypesResponse>