Kaltura ottUser API
The ottUser API from Kaltura — 18 operation(s) for ottuser.
Kaltura ottUser API is one of 222 APIs that Kaltura publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include ottUser. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and a getting-started guide.
This API exposes 18 operations across 18 paths, and defines 76 schemas. It is described by OpenAPI 2.0, at version 3.6.287.20720.
Requests are made against the base URL https://www.kaltura.com/api_v3.
18 operations
18 paths
76 schemas
18 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Kaltura ottUser API declares
1 security scheme
for authenticating requests.
An API key is passed in the body as ks (ks).
By default, every request must be authenticated.
ks— A Kaltura session ID
Paths & Operations 18
Across 18 paths, the API surfaces 18 operations — 18 POST. Each is listed below with its method, path, parameters, and response codes.
ottUser 18
POST
/service/ottuser/action/activate
Activate the account by activation token
POST
/service/ottuser/action/addRole
Edit user details.
POST
/service/ottuser/action/anonymousLogin
Returns tokens (KS and refresh token) for anonymous access
POST
/service/ottuser/action/delete
Permanently delete a user. User to delete cannot be an exclusive household master, and cannot be default user.
POST
/service/ottuser/action/get
Retrieving users' data
POST
/service/ottuser/action/getEncryptedUserId
Returns the identifier of the user encrypted with SHA1 using configured key
POST
/service/ottuser/action/list
Retrieve user by external identifier or username or if filter is null all user in the master or the user itself
POST
/service/ottuser/action/login
login with user name and password.
POST
/service/ottuser/action/loginWithPin
User sign-in via a time-expired sign-in PIN.
POST
/service/ottuser/action/logout
Logout the calling user.
POST
/service/ottuser/action/register
Sign up a new user.
POST
/service/ottuser/action/resendActivationToken
Resend the activation token to a user
POST
/service/ottuser/action/resetPassword
Send an e-mail with URL to enable the user to set new password.
POST
/service/ottuser/action/setInitialPassword
Renew the user's password after validating the token that sent as part of URL in e-mail.
POST
/service/ottuser/action/update
Update user information
POST
/service/ottuser/action/updateDynamicData
Update user dynamic data
POST
/service/ottuser/action/updateLoginData
Given a user name and existing password, change to a new password.
POST
/service/ottuser/action/updatePassword
Update the user's existing password.
Schemas 76
The contract defines 76 schemas that model the data the API accepts and returns. The most detailed are KalturaOTTUser (14 properties), KalturaProductPriceFilter (6 properties), KalturaMetaFilter (5 properties), KalturaAssetHistoryFilter (5 properties). Each schema is shown below with its type and property counts.
KalturaAssetReminderFilter
object
1 property
KalturaSeasonsReminderFilter
object
3 properties
KalturaSocialActionFilter
object
4 properties
KalturaOTTUser
object
User
14 properties
KalturaPersonalFeedFilter
object
1 property
KalturaSocialCommentFilter
object
5 properties
KalturaPersistedFilter
object
abstract
2 properties
KalturaConfigurationGroupTagFilter
object
Configuration group tag filter
2 properties
KalturaOTTUserListResponse
object
Users list
1 property
KalturaBaseOTTUser
object
Slim user data
4 properties
KalturaInboxMessageFilter
object
4 properties
KalturaEntitlementFilter
object
Entitlements filter
4 properties
KalturaFollowTvSeriesFilter
object
1 property
KalturaValue
object
abstract A representation to return an array of values
2 properties
KalturaCountryFilter
object
Country filter
4 properties
KalturaTranslationToken
object
Container for translation
2 properties
OTTRequest
object
2 properties
KalturaFilter
object
abstract
2 properties
KalturaRegionFilter
object
2 properties
KalturaAnnouncementFilter
object
order announcements
1 property
KalturaPaymentMethodProfileFilter
object
2 properties
KalturaSubscriptionFilter
object
4 properties
KalturaRecordingContextFilter
object
Filtering assets
2 properties
KalturaListResponse
object
Base list wrapper
1 property
KalturaCurrencyFilter
object
Currency filter
2 properties
KalturaOTTUserFilter
object
OTT User filter
4 properties
KalturaImageTypeFilter
object
3 properties
KalturaSeriesReminderFilter
object
3 properties
KalturaEngagementFilter
object
3 properties
KalturaParentalRuleFilter
object
2 properties
KalturaDoubleValue
object
A string representation to return an array of doubles
1 property
KalturaImageFilter
object
5 properties
KalturaReminderFilter
object
abstract
1 property
KalturaAssetHistoryFilter
object
5 properties
KalturaAssetFilter
object
2 properties
KalturaExportTaskFilter
object
Bulk export tasks filter
2 properties
KalturaTopicFilter
object
1 property
KalturaMediaFileFilter
object
3 properties
KalturaSocialFriendActivityFilter
object
4 properties
KalturaLongValue
object
A string representation to return an array of longs
1 property
KalturaReportFilter
object
abstract Report filter
2 properties
KalturaDeviceReportFilter
object
Report filter
1 property
KalturaUserAssetRuleFilter
object
User asset rule filter
3 properties
KalturaBookmarkFilter
object
Filtering Assets requests
3 properties
KalturaIntegerValue
object
A string representation to return an array of ints
1 property
KalturaUserRoleFilter
object
User roles filter
3 properties
KalturaLoginResponse
object
2 properties
KalturaRecordingFilter
object
Filtering recordings
3 properties
KalturaMultilingualStringValue
object
Array of translated strings
2 properties
KalturaPriceDetailsFilter
object
2 properties
KalturaOTTUserDynamicData
object
User dynamic data
3 properties
KalturaSeriesRecordingFilter
object
Filtering recordings
1 property
KalturaFavoriteFilter
object
Favorite request filter
4 properties
KalturaMetaFilter
object
Meta filter
5 properties
KalturaHouseholdDeviceFilter
object
3 properties
KalturaConfigurationsFilter
object
Configuration filter
2 properties
KalturaStringValue
object
A string representation to return an array of strings
1 property
KalturaLanguageFilter
object
Language filter
2 properties
KalturaChannelsFilter
object
4 properties
KalturaSubscriptionSetFilter
object
4 properties
KalturaPricePlanFilter
object
2 properties
KalturaTagFilter
object
5 properties
KalturaOTTUserType
object
User type
2 properties
KalturaAssetStructFilter
object
Filtering Asset Structs
4 properties
KalturaSearchHistoryFilter
object
1 property
KalturaLoginSession
object
Login response
1 property
KalturaProductPriceFilter
object
6 properties
KalturaHouseholdUserFilter
object
2 properties
KalturaDynamicOrderBy
object
Kaltura Asset Order
2 properties
KalturaAssetCommentFilter
object
3 properties
KalturaRelatedObjectFilter
object
abstract Define KalturaRelatedObjectFilter
1 property
KalturaConfigurationGroupDeviceFilter
object
Configuration group device filter
2 properties
KalturaBooleanValue
object
A string representation to return an array of booleans
1 property
KalturaTransactionHistoryFilter
object
Transactions filter
4 properties
KalturaCollectionFilter
object
Collection Filter
3 properties
KalturaAggregationCountFilter
object
Kaltura Aggregation CountFilter
1 property
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Kaltura 12
Other APIs Kaltura publishes across the network.
Kaltura accessControl API
Kaltura accessControlProfile API
Kaltura adminUser API
Kaltura analytics API
Kaltura annotation API
Kaltura announcement API
Kaltura appToken API
Kaltura aspera API
Kaltura asset API
Kaltura assetComment API
Kaltura assetFile API
Kaltura assetHistory API
#ottUser