# setAuthParams
Description
Select a new type of protection for controlling TrueConf VideoSDK either as a user
or administrator
If the Unprotected
authorization type is selected for the administrator
, the same authorization type will be selected for the user
In order to set the secure mode for the user
, it is necessary to set the secure
mode for the administrator
first
void setAuthParams(string sUserType, string sAuthType, string sSecret)
Parameters
Name | Description |
---|---|
sUserType | Type of account to be protected. It can be admin or user (upon availability) |
sAuthType | Authorization type. It can be as follows: • password - With a password • pin - by PIN. A new PIN will be received in the response • unsecured - Unsecurd |
sSecret | Password. This field must be available when setting up password protection |
Response example
{
"result" : true,
"newPin" : "ABC123",
"method" : "setAuthParams",
"requestId" : "1"
}
Response Parameters
Name | Description |
---|---|
token | The token for the current connection to be used in the API. If the connection is lost and a reconnection occurs, it can be used for token-based authorization. It is present if the security type for the user under which the current connection is being made has been changed. The lifespan of the token depends on the type of authentication used: • sAuthType == "unsecured" (unsecured authorization) - 30 days or until the moment when the application is closed • sAuthType == "password" (with a password) - 30 days or until the moment when the application is closed • sAuthType == "pin" (by PIN) - For 24 hours or until the application is closed • with a Token - Determined by the initial authorization during which the token was received |
tokenForHttpServer | The current connection token. It will be used on the HTTP server. The token lifetime equals 5 minutes or until the moment when the application is closed |
newPin | New PIN. This field is present if PIN protection was set: sAuthType == "pin" |
requestId | A unique request identifier |
result | A flag indicating whether the request was successful |
See also