PrivilegeIdentifier

Description

The PrivilegeIdentifier type holds the identification information for a privilege. The PrivilegeIdentifier type parameters are listed below.

Parameters

Name Type Description
name string Holds the privilege name.
Note: The privilege name is mandatory, except for the following types:
  • TS_FLDPRIVTYPE_ADMGRP
  • TS_FLDPRIVTYPE_ADMTBL
  • TS_FLDPRIVTYPE_ADMFLD
type string Holds the type of privilege.
Note: The privilege type is optional, except for the following types:
  • TS_FLDPRIVTYPE_ADMGRP
  • TS_FLDPRIVTYPE_ADMTBL
  • TS_FLDPRIVTYPE_ADMFLD

Usage

The PrivilegeIdentifier is the identifier that can be used in Web service calls to uniquely identify a privilege. The PrivilegeIdentifier contains the privilege name and type.

XML

The following XML shows PrivilegeIdentifier as seen in the <urn:privilegeName> argument of a typical call.

<urn:HasGroupPrivilege>
    <urn:auth>
        <urn:userId>bill</urn:userId>
        <urn:password>sa</urn:password>
        <urn:hostname>localhost</urn:hostname>
    </urn:auth>
    <urn:privilegeName>TS_ADMSYSPRIV_GLOBALADMIN</urn:privilegeName>
    <urn:group>
        <urn:displayName>IM Administrator</urn:displayName>
    </urn:group>
</urn:HasGroupPrivilege>

The following XML shows PrivilegeIdentifier as seen in a typical response.

<ae:GetGroupPrivilegesResponse>
   <ae:return>
      <ae:name>TS_USRSYSPRIV_EDITPROFILE</ae:name>
      <ae:type>TS_PRIVTYPE_USERSYS</ae:type>
   </ae:return>
</ae:GetGroupPrivilegesResponse>