Retrieves a list of all institution roles defined within the Blackboard Learn environment. This endpoint is crucial for administrators and developers who need to understand and manage the various roles available in their institution's Blackboard system. It provides a comprehensi…
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. "roleId(desc)" Supported fields are: - roleId - custom **Since**: 3300.4.0
limitintegerThe maximum number of results to be returned. There may be less if the query returned less than the maximum.
custombooleanSearch for institution roles by custom flag. A value of "true" indicates that search results should be limited to only custom roles. A value of "false" indicates results should be limited to built-in roles. Not setting this field indicates that all institution roles should be re…
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.
roleIdstringSearch for institution roles with roleId properties that contain this value. **Since**: 3300.4.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.