Kaltura

Kaltura permission API

Permission service lets you create and manage user permissions

GitHub OpenAPI

Documentation

📖
Documentation
https://developer.kaltura.com/api-docs/
📖
Authentication
https://developer.kaltura.com/api-docs/VPaaS-API-Getting-Started/Kaltura_API_Authentication_and_Security.html
📖
GettingStarted
https://developer.kaltura.com/api-docs/VPaaS-API-Getting-Started/Getting-Started-VPaaS-API.html
📖
Documentation
https://devdocs.api.ott.kaltura.com/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/kaltura/refs/heads/main/openapi/kaltura-permission-api-openapi.yml

Other Resources

🔗
Console
https://developer.kaltura.com/console
🔗
GraphQL
https://raw.githubusercontent.com/api-evangelist/kaltura/refs/heads/main/graphql/kaltura-graphql.md

OpenAPI Specification

kaltura-permission-api-openapi.yml Raw ↑ 
swagger: '2.0'
info:
  description: The Kaltura OTT API
  title: Kaltura OTT accessControl permission API
  version: 3.6.287.20720
host: tvpapi-us-preprod.ott.kaltura.com
basePath: /api_v3
schemes:
- https
- http
produces:
- application/json
- text/xml
security:
- ks: []
tags:
- description: Permission service lets you create and manage user permissions
  name: permission
paths:
  /service/permission/action/add:
    post:
      description: Adds a new permission object to the account.
      operationId: permission.add
      parameters:
      - $ref: '#/parameters/ks'
      - $ref: '#/parameters/format'
      - $ref: '#/parameters/clientTag'
      - $ref: '#/parameters/partnerId'
      - $ref: '#/parameters/language'
      - $ref: '#/parameters/responseProfile'
      - in: body
        name: body
        schema:
          properties:
            permission:
              $ref: '#/definitions/KalturaPermission'
          required:
          - permission
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaPermission'
        x-Errors:
          description: '* `PROPERTY_VALIDATION_CANNOT_BE_NULL`: The property "@PROP_NAME@" cannot be null

            * `PROPERTY_VALIDATION_NOT_UPDATABLE`: The property "@PROP_NAME@" cannot be updated'
      tags:
      - permission
      x-kaltura-format: post
      x-kaltura-parameters:
      - permission
  /service/permission/action/delete:
    post:
      description: Deletes an existing permission object.
      operationId: permission.delete
      parameters:
      - $ref: '#/parameters/ks'
      - $ref: '#/parameters/format'
      - $ref: '#/parameters/clientTag'
      - $ref: '#/parameters/partnerId'
      - $ref: '#/parameters/language'
      - $ref: '#/parameters/responseProfile'
      - in: body
        name: body
        schema:
          properties:
            permissionName:
              type: string
          required:
          - permissionName
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaPermission'
        x-Errors:
          description: '* `INVALID_OBJECT_ID`: Invalid object id [@ID@]'
      tags:
      - permission
      x-kaltura-format: post
      x-kaltura-parameters:
      - permissionName
  /service/permission/action/get:
    post:
      description: Retrieves a permission object using its ID.
      operationId: permission.get
      parameters:
      - $ref: '#/parameters/ks'
      - $ref: '#/parameters/format'
      - $ref: '#/parameters/clientTag'
      - $ref: '#/parameters/partnerId'
      - $ref: '#/parameters/language'
      - $ref: '#/parameters/responseProfile'
      - in: body
        name: body
        schema:
          properties:
            permissionName:
              type: string
          required:
          - permissionName
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaPermission'
        x-Errors:
          description: '* `INVALID_OBJECT_ID`: Invalid object id [@ID@]'
      tags:
      - permission
      x-kaltura-format: post
      x-kaltura-parameters:
      - permissionName
  /service/permission/action/getCurrentPermissions:
    post:
      description: Retrieves a list of permissions that apply to the current KS.
      operationId: permission.getCurrentPermissions
      parameters:
      - $ref: '#/parameters/ks'
      - $ref: '#/parameters/format'
      - $ref: '#/parameters/clientTag'
      - $ref: '#/parameters/partnerId'
      - $ref: '#/parameters/language'
      - $ref: '#/parameters/responseProfile'
      responses:
        '200':
          description: Success
          schema:
            type: string
      tags:
      - permission
      x-kaltura-format: post
      x-kaltura-parameters: []
  /service/permission/action/list:
    post:
      description: 'Lists permission objects that are associated with an account.


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


        Blocked permissions are listed unless you use a filter to exclude them.'
      operationId: permission.list
      parameters:
      - $ref: '#/parameters/ks'
      - $ref: '#/parameters/format'
      - $ref: '#/parameters/clientTag'
      - $ref: '#/parameters/partnerId'
      - $ref: '#/parameters/language'
      - $ref: '#/parameters/responseProfile'
      - in: body
        name: body
        schema:
          properties:
            filter:
              $ref: '#/definitions/KalturaPermissionFilter'
            pager:
              $ref: '#/definitions/KalturaFilterPager'
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaPermissionListResponse'
      tags:
      - permission
      x-kaltura-format: post
      x-kaltura-parameters:
      - filter
      - pager
  /service/permission/action/update:
    post:
      description: Updates an existing permission object.
      operationId: permission.update
      parameters:
      - $ref: '#/parameters/ks'
      - $ref: '#/parameters/format'
      - $ref: '#/parameters/clientTag'
      - $ref: '#/parameters/partnerId'
      - $ref: '#/parameters/language'
      - $ref: '#/parameters/responseProfile'
      - in: body
        name: body
        schema:
          properties:
            permission:
              $ref: '#/definitions/KalturaPermission'
            permissionName:
              type: string
          required:
          - permissionName
          - permission
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaPermission'
        x-Errors:
          description: '* `INVALID_OBJECT_ID`: Invalid object id [@ID@]'
      tags:
      - permission
      x-kaltura-format: post
      x-kaltura-parameters:
      - permissionName
      - permission
definitions:
  KalturaPushToNewsDistributionProfile:
    allOf:
    - $ref: '#/definitions/KalturaConfigurableDistributionProfile'
    properties:
      basePath:
        type: string
      bodyXslt:
        type: string
      certificateKey:
        type: string
      host:
        type: string
      ips:
        type: string
      namedItem:
        type: string
      password:
        type: string
        x-inputType: password
      port:
        type: integer
      protocol:
        description: '`insertOnly`


          Enum Type: `KalturaDistributionProtocol`'
        enum:
        - 1
        - 2
        - 3
        - 4
        - 5
        - 10
        type: integer
        x-enumLabels:
        - FTP
        - SCP
        - SFTP
        - HTTP
        - HTTPS
        - ASPERA
        x-enumType: KalturaDistributionProtocol
      recentNewsTimeInterval:
        type: integer
      username:
        type: string
    title: KalturaPushToNewsDistributionProfile
    type: object
  KalturaBatchJobListResponse:
    allOf:
    - $ref: '#/definitions/KalturaListResponse'
    properties:
      objects:
        items:
          $ref: '#/definitions/KalturaBatchJob'
        type: array
    title: KalturaBatchJobListResponse
    type: object
  KalturaUverseDistributionProfile:
    allOf:
    - $ref: '#/definitions/KalturaConfigurableDistributionProfile'
    properties:
      channelCopyright:
        type: string
      channelDescription:
        type: string
      channelImageLink:
        type: string
      channelImageTitle:
        type: string
      channelImageUrl:
        type: string
      channelLanguage:
        type: string
      channelLink:
        type: string
      channelTitle:
        type: string
      feedUrl:
        description: '`readOnly`'
        readOnly: true
        type: string
      ftpHost:
        type: string
      ftpLogin:
        type: string
      ftpPassword:
        type: string
    title: KalturaUverseDistributionProfile
    type: object
  KalturaServerNode:
    anyOf:
    - $ref: '#/definitions/KalturaConferenceServerNode'
    - $ref: '#/definitions/KalturaSipServerNode'
    - $ref: '#/definitions/KalturaEdgeServerNode'
    - $ref: '#/definitions/KalturaLiveClusterMediaServerNode'
    - $ref: '#/definitions/KalturaWowzaMediaServerNode'
    description: '`abstract`'
    discriminator: objectType
    properties:
      createdAt:
        description: '`readOnly`'
        readOnly: true
        type: integer
      dc:
        description: '`readOnly`


          DC where the serverNode is located'
        readOnly: true
        type: integer
      description:
        type: string
      environment:
        description: Environment
        type: string
      heartbeatTime:
        description: '`readOnly`'
        readOnly: true
        type: integer
      hostName:
        description: serverNode hostName
        type: string
      id:
        description: '`readOnly`'
        readOnly: true
        type: integer
      name:
        description: serverNode name
        type: string
      objectType:
        enum:
        - KalturaConferenceServerNode
        - KalturaSipServerNode
        - KalturaEdgeServerNode
        - KalturaLiveClusterMediaServerNode
        - KalturaWowzaMediaServerNode
        type: string
      parentId:
        description: Id of the parent serverNode
        type: string
      partnerId:
        description: '`readOnly`'
        readOnly: true
        type: integer
      status:
        description: '`readOnly`


          Enum Type: `KalturaServerNodeStatus`'
        enum:
        - 1
        - 2
        - 3
        - 4
        - 5
        readOnly: true
        type: integer
        x-enumLabels:
        - ACTIVE
        - DISABLED
        - DELETED
        - NOT_REGISTERED
        - NOT_OPERATIONAL
        x-enumType: KalturaServerNodeStatus
      systemName:
        description: serverNode uniqe system name
        type: string
      tags:
        description: serverNode tags
        type: string
      type:
        description: '`readOnly`


          Enum Type: `KalturaServerNodeType`'
        enum:
        - conference.CONFERENCE_SERVER
        - liveCluster.LIVE_CLUSTER_MEDIA_SERVER
        - sip.SIP_SERVER
        - wowza.WOWZA_MEDIA_SERVER
        - '1'
        readOnly: true
        type: string
        x-enumLabels:
        - CONFERENCE_SERVER
        - LIVE_CLUSTER_MEDIA_SERVER
        - SIP_SERVER
        - WOWZA_MEDIA_SERVER
        - EDGE
        x-enumType: KalturaServerNodeType
      updatedAt:
        description: '`readOnly`'
        readOnly: true
        type: integer
    title: KalturaServerNode
    type: object
    x-abstract: true
  KalturaIdeticDistributionProfileFilter:
    allOf:
    - $ref: '#/definitions/KalturaIdeticDistributionProfileBaseFilter'
    properties:
      orderBy:
        enum:
        - +createdAt
        - +updatedAt
        - -createdAt
        - -updatedAt
        type: string
        x-enumLabels:
        - CREATED_AT_ASC
        - UPDATED_AT_ASC
        - CREATED_AT_DESC
        - UPDATED_AT_DESC
        x-enumType: KalturaIdeticDistributionProfileOrderBy
    title: KalturaIdeticDistributionProfileFilter
    type: object
  KalturaQuizUserEntry:
    allOf:
    - $ref: '#/definitions/KalturaUserEntry'
    properties:
      calculatedScore:
        description: '`readOnly`'
        readOnly: true
        type: number
      feedback:
        type: string
      score:
        description: '`readOnly`'
        readOnly: true
        type: number
      version:
        description: '`readOnly`'
        readOnly: true
        type: integer
    title: KalturaQuizUserEntry
    type: object
  KalturaYahooDistributionProviderBaseFilter:
    allOf:
    - $ref: '#/definitions/KalturaDistributionProviderFilter'
    anyOf:
    - $ref: '#/definitions/KalturaYahooDistributionProviderFilter'
    description: '`abstract`'
    discriminator: objectType
    properties:
      objectType:
        enum:
        - KalturaYahooDistributionProviderFilter
        type: string
    title: KalturaYahooDistributionProviderBaseFilter
    type: object
    x-abstract: true
  KalturaEmailNotificationUserRecipientJobData:
    allOf:
    - $ref: '#/definitions/KalturaEmailNotificationRecipientJobData'
    description: JobData representing the dynamic user receipient array
    properties:
      filter:
        $ref: '#/definitions/KalturaUserFilter'
    title: KalturaEmailNotificationUserRecipientJobData
    type: object
  KalturaPodcastDistributionProfileBaseFilter:
    allOf:
    - $ref: '#/definitions/KalturaDistributionProfileFilter'
    anyOf:
    - $ref: '#/definitions/KalturaPodcastDistributionProfileFilter'
    description: '`abstract`'
    discriminator: objectType
    properties:
      objectType:
        enum:
        - KalturaPodcastDistributionProfileFilter
        type: string
    title: KalturaPodcastDistributionProfileBaseFilter
    type: object
    x-abstract: true
  KalturaDrmProfile:
    anyOf:
    - $ref: '#/definitions/KalturaDrmProfile'
    - $ref: '#/definitions/KalturaFairplayDrmProfile'
    - $ref: '#/definitions/KalturaPlayReadyProfile'
    - $ref: '#/definitions/KalturaWidevineProfile'
    discriminator: objectType
    properties:
      createdAt:
        description: '`readOnly`'
        readOnly: true
        type: integer
      defaultPolicy:
        type: string
      description:
        type: string
      id:
        description: '`readOnly`'
        readOnly: true
        type: integer
      licenseServerUrl:
        type: string
      name:
        type: string
      objectType:
        enum:
        - KalturaDrmProfile
        - KalturaFairplayDrmProfile
        - KalturaPlayReadyProfile
        - KalturaWidevineProfile
        type: string
      partnerId:
        description: '`insertOnly`'
        type: integer
      provider:
        description: 'Enum Type: `KalturaDrmProviderType`'
        enum:
        - fairplay.FAIRPLAY
        - playReady.PLAY_READY
        - widevine.WIDEVINE
        - '1'
        type: string
        x-enumLabels:
        - FAIRPLAY
        - PLAY_READY
        - WIDEVINE
        - CENC
        x-enumType: KalturaDrmProviderType
      signingKey:
        type: string
      status:
        description: 'Enum Type: `KalturaDrmProfileStatus`'
        enum:
        - 1
        - 2
        type: integer
        x-enumLabels:
        - ACTIVE
        - DELETED
        x-enumType: KalturaDrmProfileStatus
      updatedAt:
        description: '`readOnly`'
        readOnly: true
        type: integer
    title: KalturaDrmProfile
    type: object
  KalturaStorageProfile:
    anyOf:
    - $ref: '#/definitions/KalturaStorageProfile'
    - $ref: '#/definitions/KalturaAmazonS3StorageProfile'
    - $ref: '#/definitions/KalturaKontikiStorageProfile'
    discriminator: objectType
    properties:
      allowAutoDelete:
        description: Flag sugnifying that the storage exported content should be deleted when soure entry is deleted
        type: integer
      createFileLink:
        description: Indicates to the local file transfer manager to create a link to the file instead of copying it
        type: boolean
      createdAt:
        description: '`readOnly`'
        readOnly: true
        type: integer
      deliveryPriority:
        description: Delivery Priority
        type: integer
      deliveryProfileIds:
        items:
          $ref: '#/definitions/KalturaKeyValue'
        type: array
      deliveryStatus:
        description: 'Enum Type: `KalturaStorageProfileDeliveryStatus`'
        enum:
        - 1
        - 2
        type: integer
        x-enumLabels:
        - ACTIVE
        - BLOCKED
        x-enumType: KalturaStorageProfileDeliveryStatus
      desciption:
        type: string
      excludedEntryTypes:
        type: string
      excludedFlavorParamsIds:
        type: string
      exportPeriodically:
        type: boolean
      flavorParamsIds:
        type: string
      id:
        description: '`readOnly`'
        readOnly: true
        type: integer
      maxConcurrentConnections:
        type: integer
      maxFileSize:
        type: integer
      minFileSize:
        type: integer
      name:
        type: string
      objectType:
        enum:
        - KalturaStorageProfile
        - KalturaAmazonS3StorageProfile
        - KalturaKontikiStorageProfile
        type: string
      packagerUrl:
        type: string
      partnerId:
        description: '`readOnly`'
        readOnly: true
        type: integer
      passPhrase:
        type: string
      pathManagerClass:
        type: string
      pathManagerParams:
        items:
          $ref: '#/definitions/KalturaKeyValue'
        type: array
      pathPrefix:
        type: string
      port:
        type: integer
      privateKey:
        type: string
      protocol:
        description: 'Enum Type: `KalturaStorageProfileProtocol`'
        enum:
        - kontiki.KONTIKI
        - '0'
        - '1'
        - '2'
        - '3'
        - '6'
        - '7'
        type: string
        x-enumLabels:
        - KONTIKI
        - KALTURA_DC
        - FTP
        - SCP
        - SFTP
        - S3
        - LOCAL
        x-enumType: KalturaStorageProfileProtocol
      publicKey:
        type: string
      readyBehavior:
        description: 'Enum Type: `KalturaStorageProfileReadyBehavior`'
        enum:
        - 0
        - 1
        type: integer
        x-enumLabels:
        - NO_IMPACT
        - REQUIRED
        x-enumType: KalturaStorageProfileReadyBehavior
      rules:
        items:
          $ref: '#/definitions/KalturaRule'
        type: array
      shouldExportCaptions:
        type: boolean
      shouldExportThumbs:
        type: boolean
      status:
        description: 'Enum Type: `KalturaStorageProfileStatus`'
        enum:
        - 1
        - 2
        - 3
        type: integer
        x-enumLabels:
        - DISABLED
        - AUTOMATIC
        - MANUAL
        x-enumType: KalturaStorageProfileStatus
      storageBaseDir:
        type: string
      storageFtpPassiveMode:
        type: boolean
      storagePassword:
        type: string
      storageUrl:
        type: string
      storageUsername:
        type: string
      systemName:
        type: string
      trigger:
        description: No need to create enum for temp field
        type: integer
      updatedAt:
        description: '`readOnly`'
        readOnly: true
        type: integer
    title: KalturaStorageProfile
    type: object
  KalturaEntryVendorTaskCsvJobData:
    allOf:
    - $ref: '#/definitions/KalturaExportCsvJobData'
    properties:
      filter:
        $ref: '#/definitions/KalturaEntryVendorTaskFilter'
    title: KalturaEntryVendorTaskCsvJobData
    type: object
  KalturaUserLoginDataListResponse:
    allOf:
    - $ref: '#/definitions/KalturaListResponse'
    properties:
      objects:
        items:
          $ref: '#/definitions/KalturaUserLoginData'
        type: array
    title: KalturaUserLoginDataListResponse
    type: object
  KalturaMsnDistributionProfileBaseFilter:
    allOf:
    - $ref: '#/definitions/KalturaConfigurableDistributionProfileFilter'
    anyOf:
    - $ref: '#/definitions/KalturaMsnDistributionProfileFilter'
    description: '`abstract`'
    discriminator: objectType
    properties:
      objectType:
        enum:
        - KalturaMsnDistributionProfileFilter
        type: string
    title: KalturaMsnDistributionProfileBaseFilter
    type: object
    x-abstract: true
  KalturaUrlTokenizerCht:
    allOf:
    - $ref: '#/definitions/KalturaUrlTokenizer'
    properties: {}
    title: KalturaUrlTokenizerCht
    type: object
  KalturaFtpDropFolderBaseFilter:
    allOf:
    - $ref: '#/definitions/KalturaRemoteDropFolderFilter'
    anyOf:
    - $ref: '#/definitions/KalturaFtpDropFolderFilter'
    description: '`abstract`'
    discriminator: objectType
    properties:
      objectType:
        enum:
        - KalturaFtpDropFolderFilter
        type: string
    title: KalturaFtpDropFolderBaseFilter
    type: object
    x-abstract: true
  KalturaAttUverseDistributionFile:
    properties:
      assetId:
        type: string
      assetType:
        description: 'Enum Type: `KalturaAssetType`'
        enum:
        - attachment.Attachment
        - caption.Caption
        - document.Document
        - document.Image
        - document.PDF
        - document.SWF
        - thumbCuePoint.timedThumb
        - transcript.Transcript
        - widevine.WidevineFlavor
        - '1'
        - '2'
        - '3'
        type: string
        x-enumLabels:
        - ATTACHMENT
        - CAPTION
        - DOCUMENT
        - IMAGE
        - PDF
        - SWF
        - TIMED_THUMB_ASSET
        - TRANSCRIPT
        - WIDEVINE_FLAVOR
        - FLAVOR
        - THUMBNAIL
        - LIVE
        x-enumType: KalturaAssetType
      localFilePath:
        type: string
      remoteFilename:
        type: string
    title: KalturaAttUverseDistributionFile
    type: object
  KalturaString:
    description: A string representation to return an array of strings
    properties:
      value:
        type: string
    title: KalturaString
    type: object
  KalturaDistributionProviderListResponse:
    allOf:
    - $ref: '#/definitions/KalturaListResponse'
    properties:
      objects:
        items:
          $ref: '#/definitions/KalturaDistributionProvider'
        type: array
    title: KalturaDistributionProviderListResponse
    type: object
  KalturaFreewheelDistributionProfileBaseFilter:
    allOf:
    - $ref: '#/definitions/KalturaDistributionProfileFilter'
    anyOf:
    - $ref: '#/definitions/KalturaFreewheelDistributionProfileFilter'
    description: '`abstract`'
    discriminator: objectType
    properties:
      objectType:
        enum:
        - KalturaFreewheelDistributionProfileFilter
        type: string
    title: KalturaFreewheelDistributionProfileBaseFilter
    type: object
    x-abstract: true
  KalturaScheduleEventResourceListResponse:
    allOf:
    - $ref: '#/definitions/KalturaListResponse'
    properties:
      objects:
        items:
          $ref: '#/definitions/KalturaScheduleEventResource'
        type: array
    title: KalturaScheduleEventResourceListResponse
    type: object
  KalturaThumbAssetFilter:
    allOf:
    - $ref: '#/definitions/KalturaThumbAssetBaseFilter'
    anyOf:
    - $ref: '#/definitions/KalturaThumbAssetFilter'
    - $ref: '#/definitions/KalturaTimedThumbAssetFilter'
    discriminator: objectType
    properties:
      objectType:
        enum:
        - KalturaThumbAssetFilter
        - KalturaTimedThumbAssetFilter
        type: string
      orderBy:
        enum:
        - +createdAt
        - +deletedAt
        - +size
        - +updatedAt
        - -createdAt
        - -deletedAt
        - -size
        - -updatedAt
        type: string
        x-enumLabels:
        - CREATED_AT_ASC
        - DELETED_AT_ASC
        - SIZE_ASC
        - UPDATED_AT_ASC
        - CREATED_AT_DESC
        - DELETED_AT_DESC
        - SIZE_DESC
        - UPDATED_AT_DESC
        x-enumType: KalturaThumbAssetOrderBy
    title: KalturaThumbAssetFilter
    type: object
  KalturaPermissionItem:
    anyOf:
    - $ref: '#/definitions/KalturaApiActionPermissionItem'
    - $ref: '#/definitions/KalturaApiParameterPermissionItem'
    description: '`abstract`'
    discriminator: objectType
    properties:
      createdAt:
        description: '`readOnly`'
        readOnly: true
        type: integer
      id:
        description: '`readOnly`'
        readOnly: true
        type: integer
      objectType:
        enum:
        - KalturaApiActionPermissionItem
        - KalturaApiParameterPermissionItem
        type: string
      partnerId:
        description: '`readOnly`'
        readOnly: true
        type: integer
      tags:
        type: string
      type:
        description: '`readOnly`


          Enum Type: `KalturaPermissionItemType`'
        enum:
        - kApiActionPermissionItem
        - kApiParameterPermissionItem
        readOnly: true
        type: string
        x-enumLabels:
        - API_ACTION_ITEM
        - API_PARAMETER_ITEM
        x-enumType: KalturaPermissionItemType
      updatedAt:
        description: '`readOnly`'
        readOnly: true
        type: integer
    title: KalturaPermissionItem
    type: object
    x-abstract: true
  KalturaVendorChapteringCatalogItem:
    allOf:
    - $ref: '#/definitions/KalturaVendorCatalogItem'
    properties: {}
    title: KalturaVendorChapteringCatalogItem
    type: object
  KalturaDeliveryProfileForensicWatermark:
    allOf:
    - $ref: '#/definitions/KalturaDeliveryProfile'
    properties:
      encryptionIv:
        description: The iv used to encrypt the URI (128 bits)
        type: string
      encryptionKey:
        description: The key used to encrypt the URI (256 bits)
        type: string
      encryptionRegex:
        description: The regex used to match the encrypted part of the URI (according to the 'encrypt' named group)
        type: string
      internalUrl:
        items:
          $ref: '#/definitions/KalturaKeyValue'
        type: array
    title: KalturaDeliveryProfileForensicWatermark
    type: object
  KalturaAssetParamsOutput:
    allOf:
    - $ref: '#/definitions/KalturaAssetParams'
    properties:
      assetId:
        type: string
      assetParamsId:
        type: integer
      assetParamsVersion:
        type: string
      assetVersion:
        type: string
      format:
        description: 'Enum Type: `KalturaContainerFormat`


          The container format of the Flavor Params'
        enum:
        - 3gp
        - applehttp
        - avi
        - bif
        - bmp
        - copy
        - flv
        - hls
        - isma
        - ismv
        - jpg
        - m2ts
        - m4v
        - mkv
        - mov
        - mp3
        - mp4
        - mpeg
        - mpegts
        - mxf
        - ogg
        - ogv
        - pdf
        - png
        - swf
        - wav
        - webm
        - wma
        - wmv
        - wvm
        type: string
        x-enumLabels:
        - _3GP
        - APPLEHTTP
        - AVI
        - BIF
        - BMP
        - COPY
        - FLV
        - HLS
        - ISMA
        - ISMV
        - JPG
        - M2TS
        - M4V
        - MKV
        - MOV
        - MP3
        - MP4
        - MPEG
        - MPEGTS
        - MXF
        - OGG
        - OGV
        - PDF
        - PNG
        - SWF
        - WAV
        - WEBM
        - WMA
        - WMV
        - WVM
        x-enumType: KalturaContainerFormat
      readyBehavior:
        type: integer
    title: KalturaAssetParamsOutput
    type: object
  KalturaTVComDistributionProfileBaseFilter:
    allOf:
    - $ref: '#/definitions/KalturaConfigurableDistributionProfileFilter'
    anyOf:
    - $ref: '#/definitions/KalturaTVComDistributionProfileFilter'
    description: '`abstract`'
    discriminator: objectType
    properties:
      objectType:
        enum:
        - KalturaTVComDistributionProfileFilter
        type: string
    title: KalturaTVComDistributionProfileBaseFilter
    type: object
    x-abstract: true
  KalturaUnlimitedVendorCredit:
    allOf:
    - $ref: '#/definitions/KalturaBaseVendorCredit'
    properties:
      credit:
        description: '`readOnly`'
        readOnly: true
        type: integer
      fromDate:
        type: integer
        x-inputType: datetime
    title: KalturaUnlimitedVendorCredit
    type: object
  KalturaThumbAssetListResponse:
    allOf:
    - $ref: '#/definitions/KalturaListResponse'
    properties:
      objects:
        items:
          $ref: '#/definitions/KalturaThumbAsset'
        type: array
    title: KalturaThumbAssetListResponse
    type: object
  KalturaSearchItem:
    anyOf:
    - $ref: '#/definitions/KalturaCatalogItemAdvancedFilter'
    - $ref: '#/definitions/KalturaCategoryEntryAdvancedFilter'
    - $ref: '#/definitions/KalturaCategoryUserAdvancedFilter'
    - $ref: '#/definitions/KalturaContentDistributionSearchItem'
    - $ref: '#/definitions/KalturaEntryCaptionAdvancedFilter'
    - $ref: '#/definitions/KalturaEntryCaptionAssetSearchItem'
    - $ref: '#/definitions/KalturaEntryCuePointSearchFilter'
    - $ref: '#/definitions/KalturaEntryTranscriptAssetSearchItem'
    - $ref: '#/definitions/KalturaForensicWatermarkAdvancedFilter'
    - $ref: '#/definitions/KalturaIndexAdvancedFilter'
    - $ref: '#/definitions/KalturaQuizAdvancedFilter'
    - $ref: '#/definitions/KalturaSearchCondition'
    - $ref: '#/definitions/KalturaSearchOperator'
    - $ref: '#/definitions/KalturaViewHistoryUserEntryAdvancedFilter'
    - $ref: '#/definitions/KalturaWatchLaterUserEntryAdvancedFilter'
    - $ref: '#/definitions/KalturaBaseEntryCompareAttributeCondition'
    - $ref: '#/definitions/KalturaDataEntryCompareAttributeCondition'
    - $ref: '#/definitions/KalturaDocumentEntryCompareAttributeCondition'
    - $ref: '#/definitions/KalturaExternalMediaEntryCompareAttributeCondition'
    - $ref: '#/definitions/KalturaLiveChannelCompareAttributeCondition'
    - $ref: '#/definitions/KalturaLiveEntryCompareAttributeCondition'
    - $ref: '#/definitions/KalturaLiveStreamAdminEntryCompareAttributeCondition'
    - $ref: '#/definitions/KalturaLiveStreamEntryCompareAttributeCondition'
    - $ref: '#/definitions/KalturaMediaEntryCompareAttributeCondition'
    - $ref: '#/definitions/KalturaMixEntryCompareAttributeCondition'
    - $ref: '#/definitions/KalturaPlayableEntryCompareAttributeCondition'
    - $ref: '#/definitions/KalturaPlaylistCompareAttributeCondition'
    - $ref: '#/definitions/KalturaBaseEntryMatchAttributeCondition'
    - $ref: '#/definitions/KalturaDataEntryMatchAttributeCondition'
    - $ref: '#/definitions/KalturaDocumentEntryMatchAttributeCondition'
    - $ref: '#/definitions/KalturaExternalMediaEntryMatchAttributeCondition'
    - $ref: '#/definitions/KalturaLiveChannelMatchAttributeCondition'
    - $ref: '#/definitions/KalturaLiveEntryMatchAttributeCondition'
    - $ref: '#/definitions/KalturaLiveStreamAdminEntryMatchAttributeCondition'
    - $ref: '#/definitions/KalturaLiveStreamEntryMatchAttributeCondition'
    - $ref: '#/definitions/KalturaMediaEntryMatchAttributeCondition'
    - $ref: '#/definitions/KalturaMixEntryMatchAttributeCondition'
    - $ref: '#/definitions/KalturaPlayableEntryMatchAttributeCondition'
    - $ref: '#/definitions/KalturaPlaylistMatchAttributeCondition'
    - $ref: '#/definitions/KalturaEntryIndexAdvancedFilter'
    - $ref: '#/definitions/KalturaSearchComparableCondition'
    - $ref: '#/definitions/KalturaSearchMatchCondition'
    - $ref: '#/definitions/KalturaDynamicObjectSearchItem'
    - $ref: '#/definitions/KalturaMetadataSearchItem'
    description: '`abstract`'
    discriminator: objectType
    properties:
      objectType:
        enum:
        - KalturaCatalogItemAdvancedFilter
        - KalturaCategoryEntryAdvancedFilter
        - KalturaCategoryUserAdvancedFilter
        - KalturaContentDistributionSearchItem
        - KalturaEntryCaptionAdvancedFilter
        - KalturaEntryCaptionAssetSearchItem
        - KalturaEntryCuePointSearchFilter
        - KalturaEntryTranscriptAssetSearchItem
        - KalturaForensicWatermarkAdvancedFilter
        - KalturaIndexAdvancedFilter
        - KalturaQuizAdvancedFilter
        - KalturaSearchCondition
        - KalturaSearchOperator
        - KalturaViewHistoryUserEntryAdvancedFilter
        - KalturaWatchLaterUserEntryAdvancedFilter
        - KalturaBaseEntryCompareAttributeCondition
        - KalturaDataEntryCompareAttributeCondition
        - KalturaDocumentEntryCompareAttributeCondition
        - KalturaExternalMediaEntryCompareAttributeCondition
        - KalturaLiveChannelCompareAttributeCondition
        - KalturaLiveEntryCompareAttributeCondition
        - KalturaLiveStreamAdminEntryCompareAttributeCondition
        - KalturaLiveStreamEntryCompareAttributeCondition
        - KalturaMediaEntryCompareAttributeCondition
        - KalturaMixEntryCompareAttributeCondition
        - KalturaPlayableEntryCompareAttributeCondition
        - KalturaPlaylistCompareAttributeCondition
        - KalturaBaseEntryMatchAttributeCondition
        - KalturaDataEntryMatchAttributeCondition
        - KalturaDocumentEntryMatchAttributeCondition
        - KalturaExternalMediaEntryMatchAttributeCondition
        - KalturaLiveChannelMatchAttributeCondition
        - KalturaLiveEntryMatchAttributeCondition
        - KalturaLiveStreamAdminEntryMatchAttributeCondition
        - KalturaLiveStreamEntryMatchAttributeCondition
        - KalturaMediaEntryMatchAttributeCondition
        - KalturaMixEntryMatchAttributeCondition
        - KalturaPlayableEn

# --- truncated at 32 KB (1452 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/kaltura/refs/heads/main/openapi/kaltura-permission-api-openapi.yml