user:login | ||||
---|---|---|---|---|
Description: | ||||
Logs a user into a partner account with a partner ID, a partner user ID (puser), and a user password. |
||||
Input Params | ||||
Name | Type | Description | Required | Default Value |
partnerId | int | The identifier of the partner account | V | |
userId | string | The user's unique identifier in the partner's system | V | |
password | string | The user's password | V | |
expiry | int | The requested time (in seconds) before the generated KS expires (By default, a KS expires after 24 hours). | 86400 | |
privileges | string | Special privileges | * | |
Output Type | ||||
string | ||||
Errors | ||||
USER_NOT_FOUND,User was not found | ||||
USER_WRONG_PASSWORD,Wrong password supplied | ||||
INVALID_PARTNER_ID,Invalid partner id "%s" | ||||
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 | ||||
Example HTTP Hit | ||||
http://www.kaltura.com/api_v3/?service=user&action=login POST fields: partnerId userId password expiry privileges |