Kaltura API Documentationpartner.list

List partners by filter with paging support

Current implementation will only list the sub partners of the partner initiating the API call (using the current KS).

This action is only partially implemented to support listing sub partners of a VAR partner.

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

Request Parameters

body:object
object
filter:object:KalturaPartnerFilter
objectType:string
Enum: KalturaVarConsolePartnerFilter
orderBy:string
Enum: ADMIN_EMAIL_ASC [+adminEmail], ADMIN_NAME_ASC [+adminName], CREATED_AT_ASC [+createdAt], ID_ASC [+id], NAME_ASC [+name], STATUS_ASC [+status], WEBSITE_ASC [+website], ADMIN_EMAIL_DESC [-adminEmail], ADMIN_NAME_DESC [-adminName], CREATED_AT_DESC [-createdAt], ID_DESC [-id], NAME_DESC [-name], STATUS_DESC [-status], WEBSITE_DESC [-website]
KalturaPartnerFilter must also match all of:
object:KalturaPartnerBaseFilter
KalturaPartnerFilter must also match any of:
object:KalturaPartnerFilterobject:KalturaVarConsolePartnerFilter
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:KalturaPartnerListResponse
objects:array[object:KalturaPartner]
object:KalturaPartner
additionalParams:array[object:KalturaKeyValue]adminEmail:string
adminLoginUsersQuota:integer

readOnly

adminName:string

deprecated - lastName and firstName replaces this field

adminSecret:string

readOnly

adminUserId:string
adultContent:boolean
allowMultiNotification:integer
allowQuickEdit:integer
appearInSearch:integer
authenticationType:integer
Enum: PASSWORD_ONLY [0], TWO_FACTOR_AUTH [1], SSO [2]

readOnly

Enum Type: KalturaPartnerAuthenticationType

cdnHost:string

readOnly

cmsPassword:string

readOnly

commercialUse:integer
Enum: NON_COMMERCIAL_USE [0], COMMERCIAL_USE [1]

Enum Type: KalturaCommercialUseType

contentCategories:string
country:string

country code (2char) - this field is optional

createdAt:integer

readOnly

crmId:string

readOnly

defConversionProfileType:string
defaultDeliveryType:string

readOnly

defaultEmbedCodeType:string

readOnly

defaultEntitlementEnforcement:boolean

readOnly

deliveryTypes:array[object:KalturaPlayerDeliveryType]describeYourself:string
description:string
eSearchLanguages:array[object:KalturaESearchLanguageItem]embedCodeTypes:array[object:KalturaPlayerEmbedCodeType]firstName:string

firstName and lastName replace the old (deprecated) adminName

host:string

readOnly

id:integer

readOnly

ignoreSeoLinks:boolean

readOnly

isFirstLogin:boolean

readOnly

landingPage:string
lastName:string

lastName and firstName replace the old (deprecated) adminName

logoutUrl:string

readOnly

maxUploadSize:integer
mergeEntryLists:integer
name:string
notificationUrl:string
notificationsConfig:string
notify:integer
ottEnvironmentUrl:string

readOnly

ovpEnvironmentUrl:string

readOnly

partnerGroupType:integer
Enum: PUBLISHER [1], VAR_GROUP [2], GROUP [3], TEMPLATE [4]

readOnly

Enum Type: KalturaPartnerGroupType

partnerPackage:integer
partnerParentId:integer
phone:string
publisherEnvironmentType:integer

readOnly

publishersQuota:integer

readOnly

referenceId:string
secret:string

readOnly

state:string

state code (2char) - this field is optional

status:integer
Enum: DELETED [0], ACTIVE [1], BLOCKED [2], FULL_BLOCK [3]

readOnly

Enum Type: KalturaPartnerStatus

templatePartnerId:integer

readOnly

timeAlignedRenditions:boolean

readOnly

type:integer
Enum: KMC [1], WIKI [100], WORDPRESS [101], DRUPAL [102], DEKIWIKI [103], MOODLE [104], COMMUNITY_EDITION [105], JOOMLA [106], BLACKBOARD [107], SAKAI [108], ADMIN_CONSOLE [109]

Enum Type: KalturaPartnerType

userLandingPage:string
website:string
KalturaPartnerListResponse must also match all of:
object:KalturaListResponse