The GetUsersEndpoint retrieves user information from the Blackboard Learn system. This endpoint allows you to fetch a list of users with their associated details, supporting various query parameters for filtering, sorting, and pagination. It's particularly useful for application…
sortstringProperties to sort by. This is a comma-delimited list of JSON properties, with an optional "(desc)" suffix to request a descending sort for that property. e.g. "name.family(desc),created" Supported fields are: - userName - name.family - externalId - dataSourceId - created **Sinc…
limitintegerThe maximum number of results to be returned. There may be less if the query returned less than the maximum.
fieldsstringA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.
offsetintegerThe number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter.
createdstringSearch for users with a created date relative to this value. "createdCompare" may also be sent to control search behavior. **Since**: 3000.11.0
modifiedstringSearch for users with a modified date relative to this value. "modifiedCompare" may also be sent to control search behavior. **Since**: 3700.1.0
userNamestringSearch for users with userName properties that contain this value. **Since**: 3000.11.0
lastLoginstringSearch for users with a last login date relative to this value. "lastLoginCompare" may also be sent to control search behavior. A user who has never logged in would have a null last login date. This is not considered to be greater than, less than, or equal to a valid date. Such…
studentIdstringSearch for users with the specified studentId. **Since**: 3900.80.00
externalIdstringSearch for users with externalId properties that contain this value. **Since**: 3000.11.0
dataSourceIdstringSearch for users with this dataSourceId. This may optionally be the data source"s externalId using the syntax "externalId:math101". **Since**: 3000.11.0
name__familystringSearch for users with name.family properties that contain this value. **Since**: 3000.11.0
dataRequiredData from the action execution
errorstringError if any occurred during the execution of the action
successfulRequiredbooleanWhether or not the action execution was successful or not
OAuth connection. Risk level 2 of 5.
Free Action
No published Skills explicitly reference this Action yet.