ReportExecutionService.LogonUser Method

Logs on a user and authenticates a user request to the Report Server Web service.

Namespace:  ReportExecution2005
Assembly:  ReportExecution2005 (in ReportExecution2005.dll)

Syntax

'Declaration
<SoapDocumentMethodAttribute("http://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/LogonUser", RequestNamespace := "http://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices",  _
    ResponseNamespace := "http://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices",  _
    Use := SoapBindingUse.Literal, ParameterStyle := SoapParameterStyle.Wrapped)> _
<SoapHeaderAttribute("ServerInfoHeaderValue", Direction := SoapHeaderDirection.Out)> _
Public Sub LogonUser ( _
    userName As String, _
    password As String, _
    authority As String _
)
'Usage
Dim instance As ReportExecutionService
Dim userName As String
Dim password As String
Dim authority As String

instance.LogonUser(userName, password, _
    authority)
[SoapDocumentMethodAttribute("http://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/LogonUser", RequestNamespace = "http://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices", 
    ResponseNamespace = "http://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices", 
    Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)]
[SoapHeaderAttribute("ServerInfoHeaderValue", Direction = SoapHeaderDirection.Out)]
public void LogonUser(
    string userName,
    string password,
    string authority
)
[SoapDocumentMethodAttribute(L"http://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/LogonUser", RequestNamespace = L"http://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices", 
    ResponseNamespace = L"http://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices", 
    Use = SoapBindingUse::Literal, ParameterStyle = SoapParameterStyle::Wrapped)]
[SoapHeaderAttribute(L"ServerInfoHeaderValue", Direction = SoapHeaderDirection::Out)]
public:
void LogonUser(
    String^ userName, 
    String^ password, 
    String^ authority
)
[<SoapDocumentMethodAttribute("http://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/LogonUser", RequestNamespace = "http://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices", 
    ResponseNamespace = "http://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices", 
    Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)>]
[<SoapHeaderAttribute("ServerInfoHeaderValue", Direction = SoapHeaderDirection.Out)>]
member LogonUser : 
        userName:string * 
        password:string * 
        authority:string -> unit 
public function LogonUser(
    userName : String, 
    password : String, 
    authority : String
)

Parameters

  • authority
    Type: System.String
    Optional. The domain name to use when authenticating a user. For example, a Windows domain. Pass a value of nulla null reference (Nothing in Visual Basic) (Nothing in Visual Basic) to omit this argument.

Remarks

The table below shows header and permissions information on this operation.

SOAP Header Usage

(Out) ServerInfoHeaderValue

Native Mode Required Permissions

None

SharePoint Mode Required Permissions

None

This method only works with a Custom security extension. Please see Web Service Authentication for more information.

The LogonUser method authenticates the specified user to the Report Server Web service when custom authentication has been configured.

LogonUser must be called over Secure Sockets Layer (SSL). The method fails if it is not called securely. Upon successful authentication, the report server Web service generates an authentication cookie and returns the cookie in the HTTPS header. The response is returned over SSL.