Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kaltura userLoginPin API

The userLoginPin API from Kaltura — 4 operation(s) for userloginpin.

Kaltura userLoginPin API is one of 222 APIs that Kaltura publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include userLoginPin. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and a getting-started guide.

This API exposes 4 operations across 4 paths, and defines 2 schemas. It is described by OpenAPI 2.0, at version 3.6.287.20720.

Requests are made against the base URL https://www.kaltura.com/api_v3.

4 operations 4 paths 2 schemas 4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
3.6.287.20720
Base URL
https://www.kaltura.com/api_v3
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Kaltura userLoginPin API declares 1 security scheme for authenticating requests. An API key is passed in the body as ks (ks). By default, every request must be authenticated.

  • ks — A Kaltura session ID

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 4 POST. Each is listed below with its method, path, parameters, and response codes.

userLoginPin 4
POST
/service/userloginpin/action/add
Generate a time and usage expiry login-PIN that can allow a single login per PIN. If an active login-PIN already exists. Calling this API again for same user will add another login-PIN
userLoginPin.add 1 param → 200x-Errors
POST
/service/userloginpin/action/delete
Immediately deletes a given pre set login pin code for the user.
userLoginPin.delete 1 param → 200
POST
/service/userloginpin/action/deleteAll
Immediately expire all active login-PINs for a user
userLoginPin.deleteAll 1 param → 200
POST
/service/userloginpin/action/update
Set a time and usage expiry login-PIN that can allow a single login per PIN. If an active login-PIN already exists. Calling this API again for same user will add another login-PIN
userLoginPin.update 1 param → 200x-Errors

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are KalturaUserLoginPin (3 properties), OTTRequest (2 properties). Each schema is shown below with its type and property counts.

KalturaUserLoginPin
object
Log in pin code details
3 properties
OTTRequest
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kaltura-userloginpin-api-openapi.yml Raw ↑

Other APIs Kaltura publishes across the network.

Kaltura accessControl API
Kaltura accessControlProfile API
Kaltura adminUser API
Kaltura analytics API
Kaltura annotation API
Kaltura announcement API
Kaltura appToken API
Kaltura aspera API
Kaltura asset API
Kaltura assetComment API
Kaltura assetFile API
Kaltura assetHistory API