Kaltura API Documentationpartner.register

Create a new Partner object

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

Request Parameters

body:object
object
partner*: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
allowDefaultPasswordRestrictions:boolean

readOnly

allowMultiNotification:integer
allowQuickEdit:integer
allowedDomains:string

readOnly

allowedFromEmailWhiteList:string
appearInSearch:integer
authenticationType:integer
Enum: PASSWORD_ONLY [0], TWO_FACTOR_AUTH [1], SSO [2]

readOnly

Enum Type: KalturaPartnerAuthenticationType

blockDirectLogin:boolean

readOnly

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]eightyPercentWarning:integer

readOnly

embedCodeTypes:array[object:KalturaPlayerEmbedCodeType]eventPlatformAllowedTemplates:string
excludedAdminRoleName:string

readOnly

extendedFreeTrail:integer

readOnly

extendedFreeTrailEndsWarning:boolean

readOnly

extendedFreeTrailExpiryDate:integer

readOnly

Unix timestamp (In seconds)

extendedFreeTrailExpiryReason:string

readOnly

firstName:string

firstName and lastName replace the old (deprecated) adminName

host:string

readOnly

id:integer

readOnly

ignoreSeoLinks:boolean

readOnly

isFirstLogin:boolean

readOnly

isSelfServe:boolean
landingPage:string
lastFreeTrialNotificationDay:integer

readOnly

lastName:string

lastName and firstName replace the old (deprecated) adminName

loginBlockPeriod:integer
logoutUrl:string

readOnly

maxLoginAttempts:integer
maxUploadSize:integer
mergeEntryLists:integer
monitorUsage:integer

readOnly

name:string
notificationUrl:string
notificationsConfig:string
notify:integer
numPrevPassToKeep: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
passReplaceFreq:integer
passwordStructureValidations:array[object:KalturaRegexItem]passwordStructureValidationsDescription:string
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], READ_ONLY [4]

readOnly

Enum Type: KalturaPartnerStatus

templatePartnerId:integer

readOnly

timeAlignedRenditions:boolean

readOnly

twoFactorAuthenticationMode:integer
Enum: ALL [0], ADMIN_USERS_ONLY [1], NON_ADMIN_USERS_ONLY [2]

readOnly

Enum Type: KalturaTwoFactorAuthenticationMode

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

usageLimitWarning:integer

readOnly

userLandingPage:string
verticalClassificationId:integer

readOnly

website:string
cmsPassword:string
silent:boolean
templatePartnerId:integer

Response

Success

object:KalturaPartner
additionalParams:array[object:KalturaKeyValue]
object:KalturaKeyValue

A key value pair representation to return an array of key-value pairs (associative array)

key:string
objectType:string
Enum: KalturaKeyValue, KalturaKeyValueExtended
value:string
KalturaKeyValue must also match any of:
object:KalturaKeyValueobject:KalturaKeyValueExtended
adminEmail:string
adminLoginUsersQuota:integer

readOnly

adminName:string

deprecated - lastName and firstName replaces this field

adminSecret:string

readOnly

adminUserId:string
adultContent:boolean
allowDefaultPasswordRestrictions:boolean

readOnly

allowMultiNotification:integer
allowQuickEdit:integer
allowedDomains:string

readOnly

allowedFromEmailWhiteList:string
appearInSearch:integer
authenticationType:integer
Enum: PASSWORD_ONLY [0], TWO_FACTOR_AUTH [1], SSO [2]

readOnly

Enum Type: KalturaPartnerAuthenticationType

blockDirectLogin:boolean

readOnly

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]
object:KalturaPlayerDeliveryType
enabledByDefault:boolean
flashvars:array[object:KalturaKeyValue]id:string
label:string
minVersion:string
describeYourself:string
description:string
eSearchLanguages:array[object:KalturaESearchLanguageItem]
object:KalturaESearchLanguageItem
eSerachLanguage:string
Enum: ARABIC [Arabic], BASQUE [Basque], BRAZILIAN [Brazilian], BULGARIAN [Bulgarian], CATALAN [Catalan], CHINESE [Chinese], CZECH [Czech], DANISH [Danish], DUTCH [Dutch], ENGLISH [English], FINNISH [Finnish], FRENCH [French], GALICIAN [Galician], GERMAN [German], GREEK [Greek], HINDI [Hindi], HUNGRIAN [Hungarian], INDONESIAN [Indonesian], ITALIAN [Italian], JAPANESE [Japanese], KOREAN [Korean], LATVIAN [Latvian], LITHUANIAN [Lithuanian], NORWEGIAN [Norwegian], PERSIAN [Persian], PORTUGUESE [Prtuguese], ROMANIAN [Romanian], RUSSIAN [Russian], SORANI [Sorani], SPANISH [Spanish], SWEDISH [Swedish], THAI [Thai], TURKISH [Turkish]

Enum Type: KalturaESearchLanguage

eightyPercentWarning:integer

readOnly

embedCodeTypes:array[object:KalturaPlayerEmbedCodeType]
object:KalturaPlayerEmbedCodeType
entryOnly:boolean
id:string
label:string
minVersion:string
eventPlatformAllowedTemplates:string
excludedAdminRoleName:string

readOnly

extendedFreeTrail:integer

readOnly

extendedFreeTrailEndsWarning:boolean

readOnly

extendedFreeTrailExpiryDate:integer

readOnly

Unix timestamp (In seconds)

extendedFreeTrailExpiryReason:string

readOnly

firstName:string

firstName and lastName replace the old (deprecated) adminName

host:string

readOnly

id:integer

readOnly

ignoreSeoLinks:boolean

readOnly

isFirstLogin:boolean

readOnly

isSelfServe:boolean
landingPage:string
lastFreeTrialNotificationDay:integer

readOnly

lastName:string

lastName and firstName replace the old (deprecated) adminName

loginBlockPeriod:integer
logoutUrl:string

readOnly

maxLoginAttempts:integer
maxUploadSize:integer
mergeEntryLists:integer
monitorUsage:integer

readOnly

name:string
notificationUrl:string
notificationsConfig:string
notify:integer
numPrevPassToKeep: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
passReplaceFreq:integer
passwordStructureValidations:array[object:KalturaRegexItem]
object:KalturaRegexItem
regex:string
passwordStructureValidationsDescription:string
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], READ_ONLY [4]

readOnly

Enum Type: KalturaPartnerStatus

templatePartnerId:integer

readOnly

timeAlignedRenditions:boolean

readOnly

twoFactorAuthenticationMode:integer
Enum: ALL [0], ADMIN_USERS_ONLY [1], NON_ADMIN_USERS_ONLY [2]

readOnly

Enum Type: KalturaTwoFactorAuthenticationMode

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

usageLimitWarning:integer

readOnly

userLandingPage:string
verticalClassificationId:integer

readOnly

website:string