RESTful API Vendor

• User ID
  • ID card data should be sent based on the userID from IDP so userID must be mapped in the customer’s system.
  • The CMAuth userID (which is returned by a response from either SAML, OAuth or LDAP as one of the IDP attributes) must be mapped in the CMAuth integration profile (‘Additional Mappings’). Otherwise, userID must be returned by a response as one of the LDAP attributes.
  • This attribute needs to be added as a path or query parameter.
  • The parameter can be named userID or any other name.
• API info
  • Required Format – JSON
  • Request
    https://{HOST}/UserApi/api/users/getIDcard?userid={userID}
  • Response examples:
    • The following is an example of a valid response if the barcode is provided by the API:

      {

      "pageTitle": "Testing Header",
      "studentID": "345678901",
      "name": "Jane Doe",
      "picture": "https://...exampleImage.png",
      "department": "Computer Science",
      "status": "Full-Time Undergraduate",
      "valid_until": "31-Dec-2023",
      "barcode": "https://...exampleBarcode.png"

      }

    • The following is an example of a valid response if the barcode is generated by the App

      {

      "pageTitle": "Testing Header",
      "studentID": "345678901",
      "name": "Jane Doe",
      "picture": "https://...exampleImage.png",
      "department": "Computer Science",
      "status": "Full-Time Undergraduate",
      "valid_until": "31-Dec-2023"

      }

    • The following is an example of a valid response with the image data as a Base64 encoded string representation of the image

      {

      "pageTitle": "Example page",
      "studentID": "12345",
      "name": "John Smith",
      "picture": "data:image/png;base64,/9j/4AAQLONGBASESIXTYFOURENCODEDSTRINGKoD/2Q==",
      "department": "Computer Science",
      "status": "Active",
      "valid_until": "29-Aug-2023"

      }

    • The page title can be any information the user would like to present at the top of the page (for example, static text, user name, user ID). 
    • If the response is empty, the user gets an error message: Unable to reach the service at this time. Please try again later.
    • If one of the requested fields returns empty, it is either not displayed or displayed empty (for example Dept:), depending on the configuration (see ID Cards > Display Empty Fields options).
    • The recommended size for a barcode image is 480 px * 60 px.

IdP Details Vendor

The token based authentication attributes must be mapped in the Integration Profile (Username Mapping, Mail Mapping, First Name Mapping, Last Name Mapping, and Additional Mappings). For more information, see Configuring Integration Profiles.

The IdP Details vendor automatically tries to take the username, email, and name attributes from the authentication token. Therefore, the token based authentication attributes must be mapped in the integration profile (Username Mapping, Mail Mapping, First Name Mapping, Last Name Mapping, and Additional Mappings). For more information, see Configuring Integration Profiles.

Additional attributes from the Additional Mappings section of the integration profile can be mapped in the Custom Fields section of the ID Card product integration.

ID Number can be configured to return the username attribute or any of the mapped attributes. Note that this field is used to generate the barcode.

Alma ILS Vendor

The IDP returns the Alma ID attribute. The Alma ID attribute is a unique ID controlled by the customer that is defined per student and staff member in Alma. If you are using CMAuth, this attribute can have any name in the IDP attributes response (from SAML/OAuth/LDAP) but needs to be mapped in the Additional Mappings section of the CMAuth integration profile. If you are not using CMAuth, the Alma ID attribute must be returned in the LDAP attributes response. The attribute is configured in the User Input Identifier field in the Alma Configuration section of the App Manager configuration.

The new mapping of the authentication token requires users to log out and log in to the app.

The Alma API key requires read access.

The image file server that serves the user's picture (if any) must be either accessible publicly or added to allowed lists as per campusM guidelines.

PeopleSoft Vendor

The IDP returns the end user's PeopleSoft ID attribute. In CMAuth, this attribute can have any name in the IDP attributes response (from SAML/OAuth/LDAP) but needs to be mapped in the Additional Mappings section of the CMAuth integration profile. The attribute is configured in the User Input Identifier field in the PeopleSoft API Configuration section of the App Manager configuration.

The new mapping of the authentication token requires users to log out and log in to the app.