Help Center/ Meeting/ Client SDK Reference/ Electron SDK/ APIs/ Login Management Objects/ SSO
Updated on 2023-03-23 GMT+08:00
View PDF

SSO

Function

This API is used to log in to the system via single sign-on (SSO). You must log in to Huawei Cloud Meeting before using functions such as creating meetings and being invited into meetings. If you do not log in, you cannot experience complete meeting functions.

Function Prototype

loginBySSO(ssoAuthInfo: SSOAuthInfo, onLoginResult?: (ret: SDKERR, reason: string, loginResult: LoginResult) => void): voidloginBySSO(ssoAuthInfo: SSOAuthInfo, onLoginResult?: (ret: SDKERR, reason: string, loginResult: LoginResult) => void): void

Request Parameters

Table 1 Input parameter description
Parameter Mandatory Type Description
ssoAuthInfo Y SSOAuthInfo SSO authentication information.
onLoginResult Y (ret: SDKERR, reason: string, loginResult: LoginResult) => void Login callback.
Table 2 SSOAuthInfo
Parameter Mandatory Type Description
code Y string Authorization code.
domain Y string Enterprise domain name.
authServerType Y AuthServerType Authentication service type.
Table 3 Enumerated values of AuthServerType
Enumeration Name Enumerated Value Description
AUTH_SERVER_TYPE_OAUTH2 0 SSO.

Return Values

void

Callback Method Parameters

(ret: SDKERR, reason: string, loginResult: LoginResult) => void

Table 4 Input parameter description
Parameter Type Description
ret For details about SDKERR, see Error Code Reference. Error code.
reason string Error description.
loginResult LoginResult Login result.
Table 5 LoginResult
Parameter Type Description
userUuid string UUID, which is the unique user ID allocated by the system.
account string Account.
thirdAccount string Third-party account.
Parent topic: Login Management Objects