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

Operations 23

POST /service/user/action/add #
POST /service/user/action/addFromBulkUpload #
POST /service/user/action/checkLoginDataExists #
POST /service/user/action/delete #
POST /service/user/action/disableLogin #
POST /service/user/action/enableLogin #
POST /service/user/action/exportToCsv #
POST /service/user/action/generateQrCode #
POST /service/user/action/get #
POST /service/user/action/getByLoginId #
POST /service/user/action/index #
POST /service/user/action/list #
POST /service/user/action/login #
POST /service/user/action/loginByKs #
POST /service/user/action/loginByLoginId #
POST /service/user/action/loginDataResetPassword #
POST /service/user/action/notifyBan #
POST /service/user/action/resetPassword #
POST /service/user/action/serveCsv #
POST /service/user/action/setInitialPassword #
POST /service/user/action/update #
POST /service/user/action/updateLoginData #
POST /service/user/action/validateHashKey #

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

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/kaltura-user-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

kaltura-user-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: The Kaltura OTT API
  title: Kaltura OTT accessControl User API
  version: 3.6.287.20720
servers:
- url: https://tvpapi-us-preprod.ott.kaltura.com/api_v3
- url: http://tvpapi-us-preprod.ott.kaltura.com/api_v3
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: '#/components/parameters/ks'
      - $ref: '#/components/parameters/format'
      - $ref: '#/components/parameters/clientTag'
      - $ref: '#/components/parameters/partnerId'
      - $ref: '#/components/parameters/language'
      - $ref: '#/components/parameters/responseProfile'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KalturaUser'
            text/xml:
              schema:
                $ref: '#/components/schemas/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
      requestBody:
        content:
          application/json:
            schema:
              properties:
                user:
                  $ref: '#/components/schemas/KalturaUser'
              required:
              - user
              type: object
  /service/user/action/addFromBulkUpload:
    post:
      operationId: user.addFromBulkUpload
      parameters:
      - $ref: '#/components/parameters/ks'
      - $ref: '#/components/parameters/format'
      - $ref: '#/components/parameters/KalturaBulkUploadJobData_bulkUploadData_objectType'
      - $ref: '#/components/parameters/KalturaBulkUploadJobData_bulkUploadData_fileName'
      - $ref: '#/components/parameters/KalturaBulkUploadJobData_bulkUploadData_objectData__objectType'
      - $ref: '#/components/parameters/KalturaBulkUploadJobData_bulkUploadData_emailRecipients'
      - $ref: '#/components/parameters/KalturaBulkUploadJobData_bulkUploadData_numOfErrorObjects'
      - $ref: '#/components/parameters/KalturaBulkUploadJobData_bulkUploadData_privileges'
      - $ref: '#/components/parameters/KalturaBulkUploadUserData_bulkUploadUserData_objectType'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KalturaBulkUpload'
            text/xml:
              schema:
                $ref: '#/components/schemas/KalturaBulkUpload'
      tags:
      - user
      x-kaltura-format: file
      x-kaltura-parameters:
      - fileData
      - bulkUploadData
      - bulkUploadUserData
      x-parameterGroups:
      - description: 'Object Type: `KalturaBulkUploadJobData`'
        name: bulkUploadData
        schema:
          $ref: '#/components/schemas/KalturaBulkUploadJobData'
        subGroups:
        - name: bulkUploadData[objectData]
      - description: 'Object Type: `KalturaBulkUploadUserData`'
        name: bulkUploadUserData
        schema:
          $ref: '#/components/schemas/KalturaBulkUploadUserData'
        subGroups: []
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                fileData:
                  type: string
                  format: binary
              required:
              - fileData
  /service/user/action/checkLoginDataExists:
    post:
      description: Action which checks whther user login
      operationId: user.checkLoginDataExists
      parameters:
      - $ref: '#/components/parameters/ks'
      - $ref: '#/components/parameters/format'
      - $ref: '#/components/parameters/clientTag'
      - $ref: '#/components/parameters/partnerId'
      - $ref: '#/components/parameters/language'
      - $ref: '#/components/parameters/responseProfile'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: boolean
            text/xml:
              schema:
                type: boolean
      tags:
      - user
      x-kaltura-format: post
      x-kaltura-parameters:
      - filter
      requestBody:
        content:
          application/json:
            schema:
              properties:
                filter:
                  $ref: '#/components/schemas/KalturaUserLoginDataFilter'
              required:
              - filter
              type: object
  /service/user/action/delete:
    post:
      description: Deletes a user from a partner account.
      operationId: user.delete
      parameters:
      - $ref: '#/components/parameters/ks'
      - $ref: '#/components/parameters/format'
      - $ref: '#/components/parameters/clientTag'
      - $ref: '#/components/parameters/partnerId'
      - $ref: '#/components/parameters/language'
      - $ref: '#/components/parameters/responseProfile'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KalturaUser'
            text/xml:
              schema:
                $ref: '#/components/schemas/KalturaUser'
        x-Errors:
          description: '* `INVALID_USER_ID`: Invalid user id'
      tags:
      - user
      x-kaltura-format: post
      x-kaltura-parameters:
      - userId
      requestBody:
        content:
          application/json:
            schema:
              properties:
                userId:
                  type: string
              required:
              - userId
              type: object
  /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: '#/components/parameters/ks'
      - $ref: '#/components/parameters/format'
      - $ref: '#/components/parameters/clientTag'
      - $ref: '#/components/parameters/partnerId'
      - $ref: '#/components/parameters/language'
      - $ref: '#/components/parameters/responseProfile'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KalturaUser'
            text/xml:
              schema:
                $ref: '#/components/schemas/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
      requestBody:
        content:
          application/json:
            schema:
              properties:
                loginId:
                  type: string
                userId:
                  type: string
              type: object
  /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: '#/components/parameters/ks'
      - $ref: '#/components/parameters/format'
      - $ref: '#/components/parameters/clientTag'
      - $ref: '#/components/parameters/partnerId'
      - $ref: '#/components/parameters/language'
      - $ref: '#/components/parameters/responseProfile'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KalturaUser'
            text/xml:
              schema:
                $ref: '#/components/schemas/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
      requestBody:
        content:
          application/json:
            schema:
              properties:
                loginId:
                  type: string
                password:
                  type: string
                  x-inputType: password
                userId:
                  type: string
              required:
              - userId
              - loginId
              type: object
  /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: '#/components/parameters/ks'
      - $ref: '#/components/parameters/format'
      - $ref: '#/components/parameters/clientTag'
      - $ref: '#/components/parameters/partnerId'
      - $ref: '#/components/parameters/language'
      - $ref: '#/components/parameters/responseProfile'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
            text/xml:
              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
      requestBody:
        content:
          application/json:
            schema:
              properties:
                additionalFields:
                  items:
                    $ref: '#/components/schemas/KalturaCsvAdditionalFieldInfo'
                  type: array
                filter:
                  $ref: '#/components/schemas/KalturaUserFilter'
                mappedFields:
                  items:
                    $ref: '#/components/schemas/KalturaKeyValue'
                  type: array
                metadataProfileId:
                  type: integer
                options:
                  $ref: '#/components/schemas/KalturaExportToCsvOptions'
              type: object
  /service/user/action/generateQrCode:
    post:
      description: get QR image content
      operationId: user.generateQrCode
      parameters:
      - $ref: '#/components/parameters/ks'
      - $ref: '#/components/parameters/format'
      - $ref: '#/components/parameters/clientTag'
      - $ref: '#/components/parameters/partnerId'
      - $ref: '#/components/parameters/language'
      - $ref: '#/components/parameters/responseProfile'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
            text/xml:
              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
      requestBody:
        content:
          application/json:
            schema:
              properties:
                hashKey:
                  type: string
              required:
              - hashKey
              type: object
  /service/user/action/get:
    post:
      description: Retrieves a user object for a specified user ID.
      operationId: user.get
      parameters:
      - $ref: '#/components/parameters/ks'
      - $ref: '#/components/parameters/format'
      - $ref: '#/components/parameters/clientTag'
      - $ref: '#/components/parameters/partnerId'
      - $ref: '#/components/parameters/language'
      - $ref: '#/components/parameters/responseProfile'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KalturaUser'
            text/xml:
              schema:
                $ref: '#/components/schemas/KalturaUser'
        x-Errors:
          description: '* `INVALID_USER_ID`: Invalid user id'
      tags:
      - user
      x-kaltura-format: post
      x-kaltura-parameters:
      - userId
      requestBody:
        content:
          application/json:
            schema:
              properties:
                userId:
                  type: string
              type: object
  /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: '#/components/parameters/ks'
      - $ref: '#/components/parameters/format'
      - $ref: '#/components/parameters/clientTag'
      - $ref: '#/components/parameters/partnerId'
      - $ref: '#/components/parameters/language'
      - $ref: '#/components/parameters/responseProfile'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KalturaUser'
            text/xml:
              schema:
                $ref: '#/components/schemas/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
      requestBody:
        content:
          application/json:
            schema:
              properties:
                loginId:
                  type: string
              required:
              - loginId
              type: object
  /service/user/action/index:
    post:
      description: Index an entry by id.
      operationId: user.index
      parameters:
      - $ref: '#/components/parameters/ks'
      - $ref: '#/components/parameters/format'
      - $ref: '#/components/parameters/clientTag'
      - $ref: '#/components/parameters/partnerId'
      - $ref: '#/components/parameters/language'
      - $ref: '#/components/parameters/responseProfile'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
            text/xml:
              schema:
                type: string
        x-Errors:
          description: '* `USER_NOT_FOUND`: User was not found'
      tags:
      - user
      x-kaltura-format: post
      x-kaltura-parameters:
      - id
      - shouldUpdate
      requestBody:
        content:
          application/json:
            schema:
              properties:
                id:
                  type: string
                shouldUpdate:
                  default: true
                  type: boolean
              required:
              - id
              type: object
  /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: '#/components/parameters/ks'
      - $ref: '#/components/parameters/format'
      - $ref: '#/components/parameters/clientTag'
      - $ref: '#/components/parameters/partnerId'
      - $ref: '#/components/parameters/language'
      - $ref: '#/components/parameters/responseProfile'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KalturaUserListResponse'
            text/xml:
              schema:
                $ref: '#/components/schemas/KalturaUserListResponse'
      tags:
      - user
      x-kaltura-format: post
      x-kaltura-parameters:
      - filter
      - pager
      requestBody:
        content:
          application/json:
            schema:
              properties:
                filter:
                  $ref: '#/components/schemas/KalturaUserFilter'
                pager:
                  $ref: '#/components/schemas/KalturaFilterPager'
              type: object
  /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: '#/components/parameters/format'
      - $ref: '#/components/parameters/clientTag'
      - $ref: '#/components/parameters/partnerId'
      - $ref: '#/components/parameters/language'
      - $ref: '#/components/parameters/responseProfile'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
            text/xml:
              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
      requestBody:
        content:
          application/json:
            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
  /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: '#/components/parameters/ks'
      - $ref: '#/components/parameters/format'
      - $ref: '#/components/parameters/clientTag'
      - $ref: '#/components/parameters/partnerId'
      - $ref: '#/components/parameters/language'
      - $ref: '#/components/parameters/responseProfile'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KalturaSessionResponse'
            text/xml:
              schema:
                $ref: '#/components/schemas/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
      requestBody:
        content:
          application/json:
            schema:
              properties:
                requestedPartnerId:
                  type: integer
              required:
              - requestedPartnerId
              type: object
  /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: '#/components/parameters/format'
      - $ref: '#/components/parameters/clientTag'
      - $ref: '#/components/parameters/partnerId'
      - $ref: '#/components/parameters/language'
      - $ref: '#/components/parameters/responseProfile'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
            text/xml:
              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
      requestBody:
        content:
          application/json:
            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
  /service/user/action/loginDataResetPassword:
    post:
      description: Resets user login password
      operationId: user.loginDataResetPassword
      parameters:
      - $ref: '#/components/parameters/ks'
      - $ref: '#/components/parameters/format'
      - $ref: '#/components/parameters/clientTag'
      - $ref: '#/components/parameters/partnerId'
      - $ref: '#/components/parameters/language'
      - $ref: '#/components/parameters/responseProfile'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KalturaUser'
            text/xml:
              schema:
                $ref: '#/components/schemas/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
      requestBody:
        content:
          application/json:
            schema:
              properties:
                loginDataId:
                  type: string
                newPassword:
                  type: string
              required:
              - loginDataId
              - newPassword
              type: object
  /service/user/action/notifyBan:
    post:
      description: Notifies that a user is banned from an account.
      operationId: user.notifyBan
      parameters:
      - $ref: '#/components/parameters/ks'
      - $ref: '#/components/parameters/format'
      - $ref: '#/components/parameters/clientTag'
      - $ref: '#/components/parameters/partnerId'
      - $ref: '#/components/parameters/language'
      - $ref: '#/components/parameters/responseProfile'
      responses:
        '200':
          description: Success
        x-Errors:
          description: '* `INVALID_USER_ID`: Invalid user id'
      tags:
      - user
      x-kaltura-format: post
      x-kaltura-parameters:
      - userId
      requestBody:
        content:
          application/json:
            schema:
              properties:
                userId:
                  type: string
              required:
              - userId
              type: object
  /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: '#/components/parameters/format'
      - $ref: '#/components/parameters/clientTag'
      - $ref: '#/components/parameters/partnerId'
      - $ref: '#/components/parameters/language'
      - $ref: '#/components/parameters/responseProfile'
      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
      requestBody:
        content:
          application/json:
            schema:
              properties:
                email:
                  type: string
                linkType:
                  enum:
                  - '1'
                  - '2'
                  - '3'
                  type: string
                  x-enumLabels:
                  - KMC
                  - KMS
                  - KME
                  x-enumType: KalturaResetPassLinkType
              required:
              - email
              type: object
  /service/user/action/serveCsv:
    post:
      deprecated: true
      description: Will serve a requested CSV
      operationId: user.serveCsv
      parameters:
      - $ref: '#/components/parameters/ks'
      - $ref: '#/components/parameters/format'
      - $ref: '#/components/parameters/clientTag'
      - $ref: '#/components/parameters/partnerId'
      - $ref: '#/components/parameters/language'
      - $ref: '#/components/parameters/responseProfile'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
            text/xml:
              schema:
                type: string
      tags:
      - user
      x-kaltura-format: post
      x-kaltura-parameters:
      - id
      requestBody:
        content:
          application/json:
            schema:
              properties:
                id:
                  type: string
              required:
              - id
              type: object
  /service/user/action/setInitialPassword:
    post:
      description: Set initial user password
      operationId: user.setInitialPassword
      parameters:
      - $ref: '#/components/parameters/format'
      - $ref: '#/components/parameters/clientTag'
      - $ref: '#/components/parameters/partnerId'
      - $ref: '#/components/parameters/language'
      - $ref: '#/components/parameters/responseProfile'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KalturaAuthentication'
            text/xml:
              schema:
                $ref: '#/components/schemas/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
      requestBody:
        content:
          application/json:
            schema:
              properties:
                hashKey:
                  type: string
                newPassword:
                  type: string
              required:
              - hashKey
              - newPassword
              type: object
  /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: '#/components/parameters/ks'
      - $ref: '#/components/parameters/format'
      - $ref: '#/components/parameters/clientTag'
      - $ref: '#/components/parameters/partnerId'
      - $ref: '#/components/parameters/language'
      - $ref: '#/components/parameters/responseProfile'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KalturaUser'
            text/xml:
              schema:
                $ref: '#/components/schemas/KalturaUser'
        x-Errors:
          description: '* `INVALID_USER_ID`: Invalid user id

            * `CANNOT_DELETE_OR_BLOCK_ROOT_ADMI

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