Documentation Center

User 2.5 GetMetaData

This function retrieves the requested metadata of the specified user.


Parameters

NameTypeDirectionDescription
psAuthContextStringInOutDeprecated proprietary authentication context only used by .ASMX web services based on internal username/password authentication. Claims based security standards drive all the WCF .SVC web services making this parameter redundant.
psUserIdStringInThe element name of the user (e.g. VUSERADMIN)
psXMLRequestedMetaDataStringInRequested Metadata XML structure indicating which metadata has to be retrieved for a given object.
psOutXMLObjListStringOutThe User ObjectList XML Structure containing the metadata of the users

Note that:
  • Only an administrator can request information of another user. A non-administrator should use GetMyMetaData .
  • The field PASSWORD cannot be retrieved
For example, we are interested in the properties 'usergroups', 'userroles' and 'user name' of the user.
  1. The requested metadata XML looks like:
    <ishfields>
      <ishfield name="USERNAME" level="none"/>
      <ishfield name="FISHUSERDISPLAYNAME" level="none"/>
      <ishfield name="FISHEMAIL" level="none"/>
      <ishfield name="FUSERGROUP" level="none"/>
      <ishfield name="FISHUSERROLES" level="none"/>
      <ishfield name="FISHEXTERNALID" level="none"/>
    </ishfields>
  2. The result will look like:
    <ishobjects>
      <ishobject ishref="VUSERELEFEVER" ishtype="ISHUser" ishuserref="4484">
        <ishfields>
          <ishfield name="USERNAME" level="none">elefever</ishfield>
          <ishfield name="FISHUSERDISPLAYNAME" level="none">Erwin Lefever (elefever)</ishfield>
          <ishfield name="FISHEMAIL" level="none">elefever@sdl.com</ishfield>
          <ishfield name="FUSERGROUP" level="none">Default Department, Project team, Sales Marketing, System management</ishfield>
          <ishfield name="FISHUSERROLES" level="none">Administrator</ishfield>
          <ishfield name="FISHEXTERNALID" level="none>GLOBAL\elefever, TRIBE\erwinl</ishfield>
        </ishfields>
      </ishobject>
    </ishobjects>