Session - NYULibraries/pds-custom GitHub Wiki

Sessions are the core of PDS single sign-on. A session contains user attributes from the logged in user's identities.

Session Duration

A session lasts [an unknown period of time]

Session XML

A session's user attributes can be accessed via the PDS XML API via URLS of the form

https://pds.library.nyu.edu/pds?func=get-attribute&attribute=bor_info&pds_handle=PDS_HANDLE

Sample session XML, served as Content-Type:text/xml; charset=UTF-8

<?xml version="1.0" encoding="UTF-8"?>
<bor-info>
  <id>N########</id>
  <exl_id>N########</exl_id>
  <nyuidn>N########</nyuidn>
  <barcode>1234567890</barcode>
  <patron_status>55</patron_status>
  <bor-status>55</bor-status>
  <expiry-date>20161031</expiry-date>
  <name>Barnaby</name>
  <first_name>Barnaby</first_name>
  <givenname>Barnaby</givenname>
  <sn>Alter</sn>
  <last_name>Alter</last_name>
  <uid>netid</uid>
  <email>[email protected]</email>
  <email_address>[email protected]</email_address>
  <institute>NYU</institute>
  <verification>beeb12345678901234567890</verification>
  <nyu_shibboleth>true</nyu_shibboleth>
  <entitlement>
  urn:mace:nyu.edu:entl:its:wikispriv;urn:mace:nyu.edu:entl:its:classes;urn:mace:nyu.edu:entl:its:box;urn:mace:nyu.edu:entl:lib:eresources;urn:mace:nyu.edu:entl:its:qualtrics;urn:mace:nyu.edu:entl:its:wikispub;urn:mace:nyu.edu:entl:its:lynda;urn:mace:nyu.edu:entl:lib:ideaexchange;urn:mace:incommon:entitlement:common:1;urn:mace:nyu.edu:entl:its:wordpress
  </entitlement>
  <edupersonentitlement>
    <value>urn:mace:nyu.edu:entl:its:wikispriv</value>
    <value>urn:mace:nyu.edu:entl:its:classes</value>
    <value>urn:mace:nyu.edu:entl:its:box</value>
    <value>urn:mace:nyu.edu:entl:lib:eresources</value>
    <value>urn:mace:nyu.edu:entl:its:qualtrics</value>
    <value>urn:mace:nyu.edu:entl:its:wikispub</value>
    <value>urn:mace:nyu.edu:entl:its:lynda</value>
    <value>urn:mace:nyu.edu:entl:lib:ideaexchange</value>
    <value>urn:mace:incommon:entitlement:common:1</value>
    <value>urn:mace:nyu.edu:entl:its:wordpress</value>
  </edupersonentitlement>
  <ill-permission>Y</ill-permission>
  <college>Division of Libraries</college>
  <department>Office of the Dean</department>
  <major>IT Services & Media Services</major>
  <plif_status>PLIF LOADED</plif_status>
  <barcode>1234567890</barcode>
  <uid>netid</uid>
</bor-info>

Note: id will always be "N" number

Sample error XML, seved as Content-Type:text/html; charset=UTF-8 (Ain't PDS grand!)

<?xml version="1.0" encoding="UTF-8" ?>
<pds>
  <error>Error User does not exist</error>
</pds>

Exposing Attributes in the Session XML

If you're not seeing a desired attribute in the XML, you might have to add a mapping to the attribute. This is just how PDS works.

⚠️ **GitHub.com Fallback** ⚠️