Kaltura

Kaltura user API

Manage partner users on Kaltura's side The userId in kaltura is the unique ID in the partner's system, and the [partnerId,Id] couple are unique key in kaltura's DB

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-user-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-user-api-openapi.yml Raw ↑ 
swagger: '2.0'
info:
  description: The Kaltura OTT API
  title: Kaltura OTT accessControl user 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: "Manage partner users on Kaltura's side\n The userId in kaltura is the unique ID in the partner's system, and the [partnerId,Id] couple are unique key in kaltura's DB"
  name: user
paths:
  /service/user/action/add:
    post:
      description: 'Adds a new user to an existing account in the Kaltura database.


        Input param $id is the unique identifier in the partner''s system.'
      operationId: user.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:
            user:
              $ref: '#/definitions/KalturaUser'
          required:
          - user
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaUser'
        x-Errors:
          description: '* `DUPLICATE_USER_BY_ID`: User with id [@UID@] already exists in system

            * `PROPERTY_VALIDATION_CANNOT_BE_NULL`: The property "@PROP_NAME@" cannot be null

            * `INVALID_FIELD_VALUE`: value in field [@FIELD_NAME@] is not valid

            * `UNKNOWN_PARTNER_ID`: Unknown partner_id [@PID@]

            * `ADMIN_LOGIN_USERS_QUOTA_EXCEEDED`: Partner login users quota exceeded

            * `PASSWORD_STRUCTURE_INVALID`: The password you entered has an invalid structure.

            Passwords must obey the following rules :

            @RULES@

            * `DUPLICATE_USER_BY_LOGIN_ID`: Loginable user with email [@EMAIL@] already exists in system

            * `USER_ROLE_NOT_FOUND`: User role not found'
      tags:
      - user
      x-kaltura-format: post
      x-kaltura-parameters:
      - user
  /service/user/action/addFromBulkUpload:
    post:
      operationId: user.addFromBulkUpload
      parameters:
      - $ref: '#/parameters/ks'
      - $ref: '#/parameters/format'
      - in: formData
        name: fileData
        required: true
        type: file
      - $ref: '#/parameters/KalturaBulkUploadJobData:bulkUploadData[objectType]'
      - $ref: '#/parameters/KalturaBulkUploadJobData:bulkUploadData[fileName]'
      - $ref: '#/parameters/KalturaBulkUploadJobData:bulkUploadData[objectData][objectType]'
      - $ref: '#/parameters/KalturaBulkUploadJobData:bulkUploadData[emailRecipients]'
      - $ref: '#/parameters/KalturaBulkUploadJobData:bulkUploadData[numOfErrorObjects]'
      - $ref: '#/parameters/KalturaBulkUploadJobData:bulkUploadData[privileges]'
      - $ref: '#/parameters/KalturaBulkUploadUserData:bulkUploadUserData[objectType]'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaBulkUpload'
      tags:
      - user
      x-kaltura-format: file
      x-kaltura-parameters:
      - fileData
      - bulkUploadData
      - bulkUploadUserData
      x-parameterGroups:
      - description: 'Object Type: `KalturaBulkUploadJobData`'
        name: bulkUploadData
        schema:
          $ref: '#/definitions/KalturaBulkUploadJobData'
        subGroups:
        - name: bulkUploadData[objectData]
      - description: 'Object Type: `KalturaBulkUploadUserData`'
        name: bulkUploadUserData
        schema:
          $ref: '#/definitions/KalturaBulkUploadUserData'
        subGroups: []
  /service/user/action/checkLoginDataExists:
    post:
      description: Action which checks whther user login
      operationId: user.checkLoginDataExists
      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/KalturaUserLoginDataFilter'
          required:
          - filter
          type: object
      responses:
        '200':
          description: Success
          schema:
            type: boolean
      tags:
      - user
      x-kaltura-format: post
      x-kaltura-parameters:
      - filter
  /service/user/action/delete:
    post:
      description: Deletes a user from a partner account.
      operationId: user.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:
            userId:
              type: string
          required:
          - userId
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaUser'
        x-Errors:
          description: '* `INVALID_USER_ID`: Invalid user id'
      tags:
      - user
      x-kaltura-format: post
      x-kaltura-parameters:
      - userId
  /service/user/action/disableLogin:
    post:
      description: 'Disables a user''s ability to log into a partner account using an email address and a password.


        You may use either a userId or a loginId parameter for this action.'
      operationId: user.disableLogin
      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:
            loginId:
              type: string
            userId:
              type: string
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaUser'
        x-Errors:
          description: '* `USER_LOGIN_ALREADY_DISABLED`: User is already not allowed to login

            * `PROPERTY_VALIDATION_CANNOT_BE_NULL`: The property "@PROP_NAME@" cannot be null

            * `USER_NOT_FOUND`: User was not found

            * `CANNOT_DISABLE_LOGIN_FOR_ADMIN_USER`: Login cannot be disabled for admin users'
      tags:
      - user
      x-kaltura-format: post
      x-kaltura-parameters:
      - userId
      - loginId
  /service/user/action/enableLogin:
    post:
      description: Enables a user to log into a partner account using an email address and a password
      operationId: user.enableLogin
      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:
            loginId:
              type: string
            password:
              type: string
              x-inputType: password
            userId:
              type: string
          required:
          - userId
          - loginId
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaUser'
        x-Errors:
          description: '* `USER_LOGIN_ALREADY_ENABLED`: User is already allowed to login

            * `USER_NOT_FOUND`: User was not found

            * `ADMIN_LOGIN_USERS_QUOTA_EXCEEDED`: Partner login users quota exceeded

            * `PASSWORD_STRUCTURE_INVALID`: The password you entered has an invalid structure.

            Passwords must obey the following rules :

            @RULES@

            * `LOGIN_ID_ALREADY_USED`: Same login id is already in use'
      tags:
      - user
      x-kaltura-format: post
      x-kaltura-parameters:
      - userId
      - loginId
      - password
  /service/user/action/exportToCsv:
    post:
      description: Creates a batch job that sends an email with a link to download a CSV containing a list of users
      operationId: user.exportToCsv
      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:
            additionalFields:
              items:
                $ref: '#/definitions/KalturaCsvAdditionalFieldInfo'
              type: array
            filter:
              $ref: '#/definitions/KalturaUserFilter'
            mappedFields:
              items:
                $ref: '#/definitions/KalturaKeyValue'
              type: array
            metadataProfileId:
              type: integer
            options:
              $ref: '#/definitions/KalturaExportToCsvOptions'
          type: object
      responses:
        '200':
          description: Success
          schema:
            type: string
        x-Errors:
          description: '* `USER_EMAIL_NOT_FOUND`: Email address for user [@USER_ID@] was not found

            * `INVALID_METADATA_PROFILE`: invalid metadata profile [@PROFILE_ID@]

            * `METADATA_PROFILE_NOT_SPECIFIED`: Metadata Profile need to be specified'
      tags:
      - user
      x-kaltura-format: post
      x-kaltura-parameters:
      - filter
      - metadataProfileId
      - additionalFields
      - mappedFields
      - options
  /service/user/action/generateQrCode:
    post:
      description: get QR image content
      operationId: user.generateQrCode
      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:
            hashKey:
              type: string
          required:
          - hashKey
          type: object
      responses:
        '200':
          description: Success
          schema:
            type: string
        x-Errors:
          description: '* `INVALID_HASH`: hashKey is not valid

            * `INVALID_USER_ID`: Invalid user id

            * `ERROR_IN_QR_GENERATION`: Could not generate QR code'
      tags:
      - user
      x-kaltura-format: post
      x-kaltura-parameters:
      - hashKey
  /service/user/action/get:
    post:
      description: Retrieves a user object for a specified user ID.
      operationId: user.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:
            userId:
              type: string
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaUser'
        x-Errors:
          description: '* `INVALID_USER_ID`: Invalid user id'
      tags:
      - user
      x-kaltura-format: post
      x-kaltura-parameters:
      - userId
  /service/user/action/getByLoginId:
    post:
      description: 'Retrieves a user object for a user''s login ID and partner ID.


        A login ID is the email address used by a user to log into the system.'
      operationId: user.getByLoginId
      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:
            loginId:
              type: string
          required:
          - loginId
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaUser'
        x-Errors:
          description: '* `LOGIN_DATA_NOT_FOUND`: Login id not found

            * `USER_NOT_FOUND`: User was not found'
      tags:
      - user
      x-kaltura-format: post
      x-kaltura-parameters:
      - loginId
  /service/user/action/index:
    post:
      description: Index an entry by id.
      operationId: user.index
      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:
            id:
              type: string
            shouldUpdate:
              default: true
              type: boolean
          required:
          - id
          type: object
      responses:
        '200':
          description: Success
          schema:
            type: string
        x-Errors:
          description: '* `USER_NOT_FOUND`: User was not found'
      tags:
      - user
      x-kaltura-format: post
      x-kaltura-parameters:
      - id
      - shouldUpdate
  /service/user/action/list:
    post:
      description: '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.'
      operationId: user.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/KalturaUserFilter'
            pager:
              $ref: '#/definitions/KalturaFilterPager'
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaUserListResponse'
      tags:
      - user
      x-kaltura-format: post
      x-kaltura-parameters:
      - filter
      - pager
  /service/user/action/login:
    post:
      description: Logs a user into a partner account with a partner ID, a partner user ID (puser), and a user password.
      operationId: user.login
      parameters:
      - $ref: '#/parameters/format'
      - $ref: '#/parameters/clientTag'
      - $ref: '#/parameters/partnerId'
      - $ref: '#/parameters/language'
      - $ref: '#/parameters/responseProfile'
      - in: body
        name: body
        schema:
          properties:
            expiry:
              default: 86400
              type: integer
            partnerId:
              type: integer
            password:
              type: string
              x-inputType: password
            privileges:
              default: '*'
              type: string
            userId:
              type: string
          required:
          - partnerId
          - userId
          - password
          type: object
      responses:
        '200':
          description: Success
          schema:
            type: string
        x-Errors:
          description: '* `USER_NOT_FOUND`: User was not found

            * `USER_WRONG_PASSWORD`: Wrong password supplied

            * `INVALID_PARTNER_ID`: Invalid partner id "@PID@"

            * `LOGIN_RETRIES_EXCEEDED`: Maximum login retries exceeded. Your account has been locked and will not be available for 24 hours

            * `LOGIN_BLOCKED`: You account is locked

            * `PASSWORD_EXPIRED`: Current password has expired

            * `USER_IS_BLOCKED`: User is blocked'
      security: []
      tags:
      - user
      x-kaltura-format: post
      x-kaltura-parameters:
      - partnerId
      - userId
      - password
      - expiry
      - privileges
  /service/user/action/loginByKs:
    post:
      description: Logs a user to the destination account provided the KS' user ID is associated with the destination account and the loginData ID matches
      operationId: user.loginByKs
      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:
            requestedPartnerId:
              type: integer
          required:
          - requestedPartnerId
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaSessionResponse'
        x-Errors:
          description: '* `PARTNER_CHANGE_ACCOUNT_DISABLED`: Partner change account is disabled for current session

            * `INVALID_USER_ID`: Invalid user id

            * `PARTNER_CHANGE_ACCOUNT_DISABLED`: Partner change account is disabled for current session

            * `ADMIN_KUSER_NOT_FOUND`: The data you entered is invalid

            * `LOGIN_DATA_NOT_FOUND`: Login id not found

            * `LOGIN_BLOCKED`: You account is locked

            * `USER_IS_BLOCKED`: User is blocked

            * `INTERNAL_SERVERL_ERROR`: Internal server error occurred

            * `UNKNOWN_PARTNER_ID`: Unknown partner_id [@PID@]

            * `SERVICE_ACCESS_CONTROL_RESTRICTED`: The access to service [@SERVICE@] is forbidden due to access control restriction

            * `DIRECT_LOGIN_BLOCKED`: Direct login is blocked on this partner'
      tags:
      - user
      x-kaltura-format: post
      x-kaltura-parameters:
      - requestedPartnerId
  /service/user/action/loginByLoginId:
    post:
      description: Logs a user into a partner account with a user login ID and a user password.
      operationId: user.loginByLoginId
      parameters:
      - $ref: '#/parameters/format'
      - $ref: '#/parameters/clientTag'
      - $ref: '#/parameters/partnerId'
      - $ref: '#/parameters/language'
      - $ref: '#/parameters/responseProfile'
      - in: body
        name: body
        schema:
          properties:
            expiry:
              default: 86400
              type: integer
            loginId:
              type: string
            otp:
              type: string
            partnerId:
              type: integer
            password:
              type: string
              x-inputType: password
            privileges:
              default: '*'
              type: string
          required:
          - loginId
          - password
          type: object
      responses:
        '200':
          description: Success
          schema:
            type: string
        x-Errors:
          description: '* `USER_NOT_FOUND`: User was not found

            * `USER_WRONG_PASSWORD`: Wrong password supplied

            * `INVALID_PARTNER_ID`: Invalid partner id "@PID@"

            * `LOGIN_RETRIES_EXCEEDED`: Maximum login retries exceeded. Your account has been locked and will not be available for 24 hours

            * `LOGIN_BLOCKED`: You account is locked

            * `PASSWORD_EXPIRED`: Current password has expired

            * `USER_IS_BLOCKED`: User is blocked

            * `DIRECT_LOGIN_BLOCKED`: Direct login is blocked on this partner'
      security: []
      tags:
      - user
      x-kaltura-format: post
      x-kaltura-parameters:
      - loginId
      - password
      - partnerId
      - expiry
      - privileges
      - otp
  /service/user/action/loginDataResetPassword:
    post:
      description: Resets user login password
      operationId: user.loginDataResetPassword
      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:
            loginDataId:
              type: string
            newPassword:
              type: string
          required:
          - loginDataId
          - newPassword
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaUser'
        x-Errors:
          description: '* `INVALID_FIELD_VALUE`: value in field [@FIELD_NAME@] is not valid

            * `PASSWORD_STRUCTURE_INVALID`: The password you entered has an invalid structure.

            Passwords must obey the following rules :

            @RULES@

            * `PASSWORD_ALREADY_USED`: Chosen password has already been used

            * `LOGIN_ID_ALREADY_USED`: Same login id is already in use

            * `ADMIN_KUSER_NOT_FOUND`: The data you entered is invalid

            * `LOGIN_RETRIES_EXCEEDED`: Maximum login retries exceeded. Your account has been locked and will not be available for 24 hours

            * `LOGIN_BLOCKED`: You account is locked'
      tags:
      - user
      x-kaltura-format: post
      x-kaltura-parameters:
      - loginDataId
      - newPassword
  /service/user/action/notifyBan:
    post:
      description: Notifies that a user is banned from an account.
      operationId: user.notifyBan
      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:
            userId:
              type: string
          required:
          - userId
          type: object
      responses:
        '200':
          description: Success
        x-Errors:
          description: '* `INVALID_USER_ID`: Invalid user id'
      tags:
      - user
      x-kaltura-format: post
      x-kaltura-parameters:
      - userId
  /service/user/action/resetPassword:
    post:
      description: Reset user's password and send the user an email to generate a new one.
      operationId: user.resetPassword
      parameters:
      - $ref: '#/parameters/format'
      - $ref: '#/parameters/clientTag'
      - $ref: '#/parameters/partnerId'
      - $ref: '#/parameters/language'
      - $ref: '#/parameters/responseProfile'
      - in: body
        name: body
        schema:
          properties:
            email:
              type: string
            linkType:
              enum:
              - '1'
              - '2'
              - '3'
              type: string
              x-enumLabels:
              - KMC
              - KMS
              - KME
              x-enumType: KalturaResetPassLinkType
          required:
          - email
          type: object
      responses:
        '200':
          description: Success
        x-Errors:
          description: '* `LOGIN_DATA_NOT_FOUND`: Login id not found

            * `PASSWORD_STRUCTURE_INVALID`: The password you entered has an invalid structure.

            Passwords must obey the following rules :

            @RULES@

            * `PASSWORD_ALREADY_USED`: Chosen password has already been used

            * `INVALID_FIELD_VALUE`: value in field [@FIELD_NAME@] is not valid

            * `LOGIN_ID_ALREADY_USED`: Same login id is already in use'
      security: []
      tags:
      - user
      x-kaltura-format: post
      x-kaltura-parameters:
      - email
      - linkType
  /service/user/action/serveCsv:
    post:
      deprecated: true
      description: Will serve a requested CSV
      operationId: user.serveCsv
      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:
            id:
              type: string
          required:
          - id
          type: object
      responses:
        '200':
          description: Success
          schema:
            type: string
      tags:
      - user
      x-kaltura-format: post
      x-kaltura-parameters:
      - id
  /service/user/action/setInitialPassword:
    post:
      description: Set initial user password
      operationId: user.setInitialPassword
      parameters:
      - $ref: '#/parameters/format'
      - $ref: '#/parameters/clientTag'
      - $ref: '#/parameters/partnerId'
      - $ref: '#/parameters/language'
      - $ref: '#/parameters/responseProfile'
      - in: body
        name: body
        schema:
          properties:
            hashKey:
              type: string
            newPassword:
              type: string
          required:
          - hashKey
          - newPassword
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaAuthentication'
        x-Errors:
          description: '* `LOGIN_DATA_NOT_FOUND`: Login id not found

            * `PASSWORD_STRUCTURE_INVALID`: The password you entered has an invalid structure.

            Passwords must obey the following rules :

            @RULES@

            * `NEW_PASSWORD_HASH_KEY_EXPIRED`: Given hash key has expired

            * `NEW_PASSWORD_HASH_KEY_INVALID`: Given hash key is invalid

            * `PASSWORD_ALREADY_USED`: Chosen password has already been used

            * `INTERNAL_SERVERL_ERROR`: Internal server error occurred'
      security: []
      tags:
      - user
      x-kaltura-format: post
      x-kaltura-parameters:
      - hashKey
      - newPassword
  /service/user/action/update:
    post:
      description: 'Updates an existing user object.


        You can also use this action to update the userId.'
      operationId: user.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:
            user:
              $ref: '#/definitions/KalturaUser'
            userId:
              type: string
          required:
          - userId
          - user
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaUser'
        x-Errors:
          description: '* `INVALID_USER_ID`: Invalid user id

            * `CANNOT_DELETE_OR_BLOCK_ROOT_ADMIN_USER`: Root admin user cannot be deleted

            * `USER_ROLE_NOT_FOUND`: User role not found

            * `ACCOUNT_OWNER_NEEDS_PARTNER_ADMIN_ROLE`: Account owner must have a partner administrator role'
      tags:
      - user
      x-kaltura-format: post
      x-kaltura-parameters:
      - userId
      - user
  /service/user/action/updateLoginData:
    post:
      description: 'Updates a user''s login data: email, password, name.'
      operationId: user.updateLoginData
      parameters:
      - $ref: '#/parameters/format'
      - $ref: '#/parameters/clientTag'
      - $ref: '#/parameters/partnerId'
      - $ref: '#/parameters/language'
      - $ref: '#/parameters/responseProfile'
      - in: body
        name: body
        schema:
          properties:
            newFirstName:
              type: string
            newLastName:
              type: string
            newLoginId:
              type: string
            newPassword:
              type: string
            oldLoginId:
              type: string
            otp:
              type: string
            password:
              type: string
              x-inputType: password
          required:
          - oldLoginId
          - password
          type: object
      responses:
        '200':
          description: Success
        x-Errors:
          description: '* `INVALID_FIELD_VALUE`: value in field [@FIELD_NAME@] is not valid

            * `PASSWORD_STRUCTURE_INVALID`: The password you entered has an invalid structure.

            Passwords must obey the following rules :

            @RULES@

            * `PASSWORD_ALREADY_USED`: Chosen password has already been used

            * `LOGIN_ID_ALREADY_USED`: Same login id is already in use

            * `ADMIN_KUSER_NOT_FOUND`: The data you entered is invalid

            * `LOGIN_RETRIES_EXCEEDED`: Maximum login retries exceeded. Your account has been locked and will not be available for 24 hours

            * `LOGIN_BLOCKED`: You account is locked'
      security: []
      tags:
      - user
      x-kaltura-format: post
      x-kaltura-parameters:
      - oldLoginId
      - password
      - newLoginId
      - newPassword
      - newFirstName
      - newLastName
      - otp
  /service/user/action/validateHashKey:
    post:
      description: Validate hash key
      operationId: user.validateHashKey
      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:
            hashKey:
              type: string
          required:
          - hashKey
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaAuthentication'
        x-Errors:
          description: '* `LOGIN_DATA_NOT_FOUND`: Login id not found

            * `NEW_PASSWORD_HASH_KEY_INVALID`: Given hash key is invalid

            * `NEW_PASSWORD_HASH_KEY_EXPIRED`: Given hash key has expired

            * `INVALID_ACCESS_TO_PARTNER_SPECIFIC_SEARCH`: Invalid access to PARTNER_SPECIFIC search from partner [@PID@]

            * `INTERNAL_SERVERL_ERROR`: Internal server error occurred'
      tags:
      - user
      x-kaltura-format: post
      x-kaltura-parameters:
      - hashKey
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/KalturaSipSe

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