Collapse All Expand All

C#

Q-Pulse Web Services
ICore..::..Authenticate Method
ICore Interface See Also Send Feedback

[This is preliminary documentation and is subject to change.]

Returns an authentication token that can be used to access services that require authentication.

Namespace: QPulseWebServices.Contracts.Service
Assembly: QPulseWebServices (in QPulseWebServices.dll) Version: 2.0.2.70

# Syntax

C#
    string Authenticate(
    	string userName,
    	string password,
    	string database
    )

#### Parameters

userName
  Type: System..::..String
  The Q-Pulse users User Name

password
  Type: System..::..String
  The Q-Pulse users Password.

database
  Type: System..::..String
  The name of the database to log in to.

#### Return Value

An authentication token

# Remarks

REST Availability: Supports HTTP POST

# Exceptions

Exception | Condition
--- | ---
ServiceFaultCode..::..AuthenticationFailed | The requested credentials could not be authenticated.
ServiceFaultCode..::..InvalidDatabase | The requested database either does not exist or is not available.

# See Also

ICore Interface
QPulseWebServices.Contracts.Service Namespace