User Resource

URL and Supported Requests

The User Resource supports five operations.

Operation Resource URL HTTP METHOD
Create https://{institution-identifier}.share.worldcat.org/idaas/scim/v2/Users
POST
Read https://{institution-identifier}.share.worldcat.org/idaas/scim/v2/Users/{id} GET
Update https://{institution-identifier}.share.worldcat.org/idaas/scim/v2/Users/{id} PUT
Delete https://{institution-identifier}.share.worldcat.org/idaas/scim/v2/Users/{id} DELETE
Search https://{institution-identifier}.share.worldcat.org/idaas/scim/v2/Users/.search POST

Response Formats

Schema

More information about the proper structure of JSON made as part of POST and PUT requests can be found in the User Data Schema.

Searching

Searches return a single User record. User data can be searched based on the ExternalID for the user. The user's ExternalID is either the barcode of the user or the user's correlation information. Which of these data points is used is based on the configuration of the client's WSkey.

Example

        {
           "schemas": ["urn:ietf:params:scim:api:messages:2.0:SearchRequest"],
           "filter": "External_ID eq \"2200998\""
        } 











Notes

Institution asserted data versus Self asserted data

There are two types of data about users in the system:

  • institution asserted data
  • self asserted data

Institution asserted data is data that is loaded and maintained by an institution via data load, the Admin panel in the WMS staff interface and this API. Self-asserted data is data that the user asserts about themselves within the system either via this API or the user portal.

Required Fields Necessary for Product Functionality

  1. WMS Circulation
    1. All circInfo elements
  2.  Notification from Resource Sharing, Circulation or Passwords
    1. Either a self asserted or institution asserted email
  3. Authentication against an external IDP
    1. Correlation data
  4. Ingest and Data load
    1. the appropriate match element in use
      1. correlation data
      2. barcode
      3. username

Creating Users

  1. For a user which wants to use the Circulation portion of WorldShare Management Services we reccomend at least the following fields:
    1. givenName
    2. familyName
    3. email
    4. circulationInfo section
      1. barcode
      2. borrowerCategory
      3. homeBranch
  2. Libraries with external IDPs such as Shibboleth, LDAP, CAS need to make sure they load appropriate correlationInfo
 

Updating Users

The following fields are read-only

  • oclcPPID
  • institution
  • oclcNamespace
  • notes
    • Notes can be added to the system but existing notes cannot be edited

Emptying Fields

The following fields can be emptied by sending blank values

  • familyName
  • givenName
  • middleName
  • honorificPrefix
  • honorificSuffix
  • nickName
  • emails
    if an attribute exist, it replaces all existing data; if the list is empty or if all items have empty value or no value, all existing items are removed.
  • phoneNumbers
    if an attribute exist, it replaces all existing data; if the list is empty or if all items have empty value or no value, all existing items are removed.
  • photos
    if an attribute exist, it replaces all existing data; if the list is empty or if all items have empty value or no value, all existing items are removed.
  • addresses
    if an attribute exist, it replaces all existing data; if the list is empty or if all items have empty value or no value, all existing items are removed.
  • wmscircpatroninfo
    Empty circulationInfo removes existing data
  • wsillinfo
    Empty illInfo removes existing data