Kaltura API Documentationuser.list

Lists user objects that are associated with an account.

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

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

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

Request Parameters

body:object
object
filter:object:KalturaUserFilter
firstNameOrLastNameStartsWith:string
idOrScreenNameStartsWith:string
loginEnabledEqual:integer
Enum: NULL_VALUE [-1], FALSE_VALUE [0], TRUE_VALUE [1]

Enum Type: KalturaNullableBoolean

objectType:string
Enum: KalturaUserFilter, KalturaGroupFilter, KalturaAdminUserFilter
orderBy:string
Enum: CREATED_AT_ASC [+createdAt], ID_ASC [+id], UPDATED_AT_ASC [+updatedAt], CREATED_AT_DESC [-createdAt], ID_DESC [-id], UPDATED_AT_DESC [-updatedAt]
permissionNamesMultiLikeAnd:string

Permission names filter expression

permissionNamesMultiLikeOr:string

Permission names filter expression

roleIdEqual:string
roleIdsEqual:string
roleIdsIn:string
KalturaUserFilter must also match all of:
object:KalturaUserBaseFilter
KalturaUserFilter must also match any of:
object:KalturaUserFilterobject:KalturaGroupFilterobject:KalturaAdminUserFilter
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

object:KalturaUserListResponse
objects:array[object:KalturaUser]
object:KalturaUser
attendanceInfo:string
company:string
dateOfBirth:integer
encryptedSeed:string

readOnly

externalId:string

insertOnly

This field should be sent instead of the id field whenever you want to work with hashed user ids

firstName:string
gender:integer
Enum: UNKNOWN [0], MALE [1], FEMALE [2]

Enum Type: KalturaGender

isAccountOwner:boolean

insertOnly

isAdmin:boolean
isGuest:boolean

insertOnly

isSsoExcluded:boolean
ksPrivileges:string
lastName:string
loginEnabled:boolean

insertOnly

objectType:string
Enum: KalturaUser, KalturaAdminUser
password:string

insertOnly writeOnly

registrationInfo:string
roleIds:string
roleNames:string

readOnly

title:string
type:integer
Enum: USER [0], GROUP [1]

Enum Type: KalturaUserType

KalturaUser must also match all of:
object:KalturaBaseUser
KalturaUser must also match any of:
object:KalturaUserobject:KalturaAdminUser
KalturaUserListResponse must also match all of:
object:KalturaListResponse