user:disablelogin | |||||
---|---|---|---|---|---|
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. |
|||||
Input Params | |||||
Name | Type | Description | Required | Default Value | Restrictions |
userId | string | The user's unique identifier in the partner's system | |||
loginId | string | The user's email address that identifies the user for login | |||
Output Type | |||||
KalturaUser | |||||
Errors | |||||
USER_LOGIN_ALREADY_DISABLED;;User is already not allowed to login | |||||
PROPERTY_VALIDATION_CANNOT_BE_NULL;PROP_NAME;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 | |||||
Example HTTP Hit | |||||
http://www.kaltura.com/api_v3/?service=user&action=disablelogin POST fields: userId loginId |