Retrieves a list of all system roles defined in the Blackboard Learn platform. This endpoint provides comprehensive information about the various roles that can be assigned to users within the system, including their associated permissions and access levels. It is particularly u…
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: <ul - roleId - custom **Since**: 3300.5.0
limitintegerThe maximum number of results to be returned. There may be less if the query returned less than the maximum.
custombooleanSearch for system 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 system roles should be returned. **…
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 system roles with roleId **Since**: 3300.5.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.