Retrieves a list of available course roles in the Blackboard Learn system. This endpoint allows users to fetch all predefined roles that can be assigned to users within courses. It is useful for administrators and developers who need to understand the available role options when…
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" **Since**: 3100.0.0
limitintegerThe maximum number of results to be returned. There may be less if the query returned less than the maximum.
custombooleanSearch course roles by whether they are a custom or system generated course role. **Since**: 3300.5.0
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 course roles using their roleId"s. Any course role with a roleId that contains the given string will be returned. The search is case insensitive. **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.