Enhanced user data retrieval with secondary IDs via REST API - 3900.80
Blackboard Learn SaaS, Blackboard Learn 9.1
Ultra Experience, Original Experience
Ultra Course View, Original Course View
Impact: Administrators
Related topic: Learn APIs
The option to retrieve user data is crucial for administrators and support roles. User data retrieval is important for a host of reasons. For example, it allows institutions to ensure access control, user support, and data security.
In the past, retrieving user data depended on a single ID. Now, we are expanding the capabilities of the users' REST APIs to support secondary IDs. This will provide more flexibility and control when accessing user information.
Users can now use a secondary ID:
- Contact Email: Users can now use the "contact.email" secondary ID to retrieve user data. This enhancement allows users to access their information by their institution/personal email address.
- Student IDs: The "studentId" secondary ID is now supported in the GET /users public endpoint. You can use this feature to access user data using their student ID.
- "Name" as New Attribute: Users can now retrieve user data based on attributes such as the user name. For this, we have the new query parameter "?name=". This will allow filtering by full names (first names, last names, middle names, or usernames).
These changes provide a significant improvement in the way users can manage user data via REST APIs.
For administrators: The required entitlements for User API remain unchanged.