Log in to an ImageQuest cabinet as the specified ImageQuest user
Namespace:
Informa.ImageQuest.API.Library
Assembly:
Informa.ImageQuest.API.Library (in Informa.ImageQuest.API.Library.dll) Version: 14.3.0.0
Syntax string Login(
string username,
string password,
string cabinet
)
Function Login (
username As String,
password As String,
cabinet As String
) As String
Parameters
- username
- Type: SystemString
Name of the ImageQuest user - password
- Type: SystemString
Password for the specified user - cabinet
- Type: SystemString
ImageQuest cabinet to connect to
Return Value
Type:
String
A User Authentication Token associated with an ImageQuest connection to the specified cabinet with the
supplied credentials.
Remarks
The API consumer must call either this Login(String, String, String) method, the SSOLogin(String) method, or the
SystemLogin(String) method, to obtain an authentication token before making any other requests to the
API. This authentication token must be supplied to all other API methods.
The specified user must have access to the cabinet being requested. All future API calls are made within the
context of this user's credentials, including the permissions and available list of document types.
See Also