Product Documentation

Obtaining a List of Applications Available to a User - lookupApplicationRequest

Feb 07, 2011

Use the lookupApplicationRequest operation to obtain a list of the applications (including their application IDs) available to a specific user. In Single Sign-on, the set of application definitions available to a user is determined by the user configuration associated with the user in the console. These application definitions are not owned by a user and cannot be edited outside of the console.

Syntax

<lookupApplicationRequest requestID=RA-generated-ID' 
returns='everything' executionMode='synchronous'> 
   <ctxs:authentication-token>AuthToken 
   </ctxs:authentication-token> 
   <psoID ID='userFQDN'/> 
</lookupApplicationRequest>

Parameters

requestID (mandatory) This is the client-generated ID that associates the return values with this request.
authentication-token (mandatory) The authentication-token element is mandatory, but is not used at this time.
psoID (mandatory) The psoID is a unique identifier for each end user; PSOID is the user's FQDN.

Syntax for Return Values — lookupApplicationResponse

<lookupApplicationResponse status="success" 
requestID="client-generated-ID"> 
<pso> 
<psoID ID='userFQDN'/> 
<data> 
   <ctxs:application xmlns:ctxs="http://citrix.com/Provision"> 
      <ctxs:id>app-GUID1</ctxs:id> 
      <ctxs:name>Outlook</ctxs:name> 
      <ctxs:description>Outlook 2003</ctxs:description> 
      <ctxs:group password-sharing='true'>Domain</ctxs:group> 
      <ctxs:fields> 
         <ctxs:userID/> 
         <ctxs:password/> 
         <ctxs:custom-field index='1' label='Domain'/> 
         <ctxs:custom-field index='2' label='Exchange Server'/> 
      </ctxs:fields> 
   </ctxs:application> 
   <ctxs:application xmlns:ctxs="http://citrix.com/Provision"> 
      <ctxs:id>app-GUID2</ctxs:id> 
      <ctxs:name>Vantive</ctxs:name> 
      <ctxs:description>Bug Database</ctxs:description> 
      <ctxs:group password-sharing='false'>SAP</ctxs:group> 
      <ctxs:fields> 
         <ctxs:userID/> 
         <ctxs:password/> 
         <ctxs:custom-field index='1' label='Domain'/> 
      </ctxs:fields> 
   </ctxs:application> 
</data> 
</pso> 
</lookupApplicationResponse>

Parameters for Return Values

status (mandatory) Possible values: Success, Failure, Pending
requestID (mandatory) This is the client-generated ID that associates these return values with the associated request.
psoID (mandatory) The psoID is a unique identifier for each end user; PSOID is the user's FQDN.
data (mandatory) Data is the description of the data being modified. This is the credential element and may include any child elements of the credential and application elements.
ctxs:application (mandatory) The application element is used both to describe an application definition and to describe details of a credential. The application element must correspond to one previously obtained from a lookupApplicationRequest operation. There is exactly one application element for each application element for each application definition available in the user configuration. See ctxs:application for more information.

Remarks

A lookup of this type of data is an anomaly not covered in standard SPML semantics. A custom capability is used to obtain the list of application definitions available to a user.