logIn
Retrieves the Protocol Access Key (pak) from the VidyoPortal.
This method can use the following parameters.
Request parameter
|
Name |
Type |
Description |
Required |
|---|---|---|---|
|
(Always Empty) |
|
Use only the HTTP Authentication header |
N/A |
|
returnEndpointBehavior |
Boolean |
Flag to return the endpoint behavior if configured |
No |
|
returnAuthToken |
Boolean |
Flag to return the authentication token |
No |
|
returnPortalVersion |
Boolean |
Flag to return the corresponding VidyoPortal version |
No |
Response parameters
|
Name |
Type |
Description |
Required |
|---|---|---|---|
|
Pak |
String |
The Portal Access Key- If the user’s authentication is successful, the Portal Access Key is returned |
Yes |
|
vmaddress |
String |
VidyoManager address |
No |
|
proxyaddress |
String |
VidyoProxy address |
No |
|
Loctag |
String |
Location Tag (to be used for cascading scenarios) |
No |
|
pak2 |
String |
Returns the PAK2 string when PAK2 is supported by the VidyoPortal |
No |
|
authToken |
String |
Authentication token that can be used in subsequent requests |
No |
|
portalVersion |
String |
The VidyoPortal version |
No |
Faults
|
Name |
Description |
|---|---|
|
NotLicensedFault |
API is not licensed |
|
GeneralFault |
An unspecified error occurred |
|
InvalidArgumentFault |
The arguments that were passed into services were wrong |
|
SeatLicenseExpiredFault |
Seat license expired and needs to be renewed |