Navigate

Kaltura API DocumentationuserRole.list

Lists user role objects that are associated with an account.

Blocked user roles are listed unless you use a filter to exclude them.

Deleted user roles are not listed unless you use a filter to include them.

Try it out
post https://www.kaltura.com/api_v3/service/userrole/action/list

Request Parameters

body:object
SchemaExample
object
filter:object:KalturaUserRoleFilter
orderBy:string
Enum: CREATED_AT_ASC [+createdAt], ID_ASC [+id], NAME_ASC [+name], UPDATED_AT_ASC [+updatedAt], CREATED_AT_DESC [-createdAt], ID_DESC [-id], NAME_DESC [-name], UPDATED_AT_DESC [-updatedAt]
KalturaUserRoleFilter must also match all of:
object:KalturaUserRoleBaseFilter
pager:object:KalturaFilterPager
The KalturaFilterPager object enables paging management to be applied upon service list actions.


KalturaFilterPager must also match all of:
object:KalturaPager

Response

Success

SchemaExample
object:KalturaUserRoleListResponse
objects:array[object:KalturaUserRole]
object:KalturaUserRole
createdAt:integer
readOnly


description:string
id:integer
readOnly


name:string
partnerId:integer
readOnly


permissionNames:string
status:integer
Enum: ACTIVE [1], BLOCKED [2], DELETED [3]
Enum Type: KalturaUserRoleStatus


systemName:string
tags:string
updatedAt:integer
readOnly


KalturaUserRoleListResponse must also match all of:
object:KalturaListResponse