[Expand]General Information
[Expand]WinForms Controls
[Expand]ASP.NET Controls and MVC Extensions
[Expand]ASP.NET Bootstrap Controls
[Expand]ASP.NET Core Bootstrap Controls
[Expand]WPF Controls
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Office File API
[Expand]Reporting
[Collapse]Report and Dashboard Server
 [Expand]Installation
  License and Distribution
 [Expand]Administrative Panel
 [Expand]Create Reports
 [Expand]Create Dashboards
 [Collapse]Configuration and API
   Report and Dashboard Server Authentication
   Manage Scheduled Jobs
   Specify Timeouts
   Switch to the HTTPS Protocol
   Scripts
  User-Specific Functions
  Localization
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]eXpress Persistent Objects
[Expand]CodeRush
[Expand]CodeRush Classic
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation
View this topic on docs.devexpress.com (Learn more)

Report and Dashboard Server Authentication

This document describes the application programming interface (API) that you can use to connect to a Report and Dashboard Server from a custom application under any platform. After the connection is established, the application can utilize the provided client-side API to communicate with a Report and Dashboard Server and perform various report managing and publishing operations.

To establish connection to a Report and Dashboard Server, use one of the following connection providers, depending on the required authentication method.

  • GuestConnectionProvider - used to connect to a Report and Dashboard Server as a guest. This connection provider uses the special Guest account. Make sure that this account is activated on the server if you want your client application to use the guest authentication. For more information on managing user accounts, refer to the Manage User Accounts and Grant Security Permissions topic.
  • ServerUserConnectionProvider - used to connect to a Report and Dashboard Server as a registered user, by providing the user name and password.
  • WindowsUserConnectionProvider - used to connect to a Report and Dashboard Server as a registered user using the integrated Windows authentication.

All connection providers expose the following methods used to establish connection to a Report and Dashboard Server.

  • LoginAsync - asynchronously login to a Report and Dashboard Server.
  • CreateClient - initialize a report service client within the current login session, established by calling the LoginAsync method.
  • ConnectAsync - asynchronously login to a Report and Dashboard Server and initialize a Report and Dashboard Server client within the current login session. This method combines the functionality of the LoginAsync and CreateClient methods.

As the result of executing the CreateClient and the ConnectAsync methods, a ReportServerClient (see ReportServerClient) is created, providing methods for client-server interaction with a Report and Dashboard Server.

The following code sample demonstrates how you can use the described API to login to a local Report and Dashboard Server as a guest user.

To learn more about different scenarios for using the Report and Dashboard Server API for authentication and client-server interaction with a server, see the following code examples online.

Is this topic helpful?​​​​​​​