GetTypePrivileges

Description

This services returns the list of privileges by type.

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	Filters the privilege by type.

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 call to return a list of privileges that exist for each privilege type. Only privilege type names returned by GetPrivilegeTypes are considered as valid values for the <urn:privilegeType> parameter.

No privileges are returned for the TS_FLDPRIVTYPE_ADMGRP and TS_FLDPRIVTYPE_ADMTBL administrative types; therefore, these types should be used alone to create unique PrivilegeIdentifiers.

Note: Different lists of privileges might be returned for a given type in different versions of SBM.

Faults

None.

XML

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

<urn:GetTypePrivileges>
    <urn:auth>
        <urn:userId>bill</urn:userId>
        <urn:password></urn:password>
        <urn:hostname></urn:hostname>
    </urn:auth>
    <urn:privilegeType>TS_PRIVTYPE_USERFLD</urn:privilegeType>
</urn:GetTypePrivileges>

The response:

<ae:GetTypePrivilegesResponse>
   <ae:return>TS_USRFLDPRIV_VIEWFOLDERITEMS</ae:return>
   <ae:return>TS_USRFLDPRIV_ADDTOFOLDER</ae:return>
   <ae:return>TS_USRFLDPRIV_REMOVEFROMFOLDER</ae:return>
</ae:GetTypePrivilegesResponse>