MultiArchive SDK .NET Documentation |
LogonService..::..Authenticate Method |
LogonService Class See Also Send Feedback |
[This is preliminary documentation and is subject to change.]
Authenticating a user against MultiArchive and returns a Credentials object containing a sercuritytoken and sessionId.
The credentials must be used when invoking all other services on MultiArchive.
The credentials must be used when invoking all other services on MultiArchive.
Namespace: MultiArchive.SDK.Services
Assembly: MultiArchive.SDK (in MultiArchive.SDK.dll) Version: 1.2.30.413 (1.2.30.413)
Syntax
C# |
---|
public Credentials Authenticate( string user, string pass ) |
Visual Basic |
---|
Public Function Authenticate ( user As String, pass As String ) As Credentials |
Visual C++ |
---|
public: Credentials^ Authenticate( String^ user, String^ pass ) |
Parameters
- user
- Type: System..::..String
Username for the user to be authenticated.
- pass
- Type: System..::..String
Password for the user to be authenticated.
Return Value
Type: CredentialsThe method returns a Credentials object which is to be used when invoking other service calls.
Exceptions
Exception | Condition |
---|---|
MultiArchive.SDK.Services.Exceptions..::..LogonException | Throws a LogonException if the specified username and password is not authenticated. |