Open this page in the API Guide

AccountController Class

The REST API for performing administration tasks on an account.
Inheritance Hierarchy

Namespace:  Dundas.BI.WebApi.Controllers
Assembly:  Dundas.BI.WebApi (in Dundas.BI.WebApi.dll) Version: 2.0.0.0 (25.1.0.1000)
Syntax
public class AccountController : ApiControllerBase

The AccountController type exposes the following members.

Constructors
  NameDescription
Public methodAccountController
Initializes a new instance of the AccountController class.
Top
Methods
  NameDescription
Public methodAddToTenants
Adds the account to the specified tenants.
Public methodChangePassword
Updates the password for the current account, or if an account ID is specified, the password for the specified account.
Public methodClearExternalGroupCache
Clears the external group cache for the specified account.
Public methodConvertAllWindowsAccountsToLocalAccounts
Converts a Windows all user/group accounts to a accounts.
Public methodConvertWindowsAccountToExternalAccount
Converts a Windows user/group account to an External user/group account.
Public methodConvertWindowsAccountToLocalAccount
Converts a Windows user/group account to a local account.
Public methodCreateAccount
Creates a user account of the requested type.
Public methodDeleteAccount
Deletes an account.
Public methodDownload
Gets the requested download as a binary stream.
Protected methodEnsureCallerContext
If the current context is not already the specified context, creates a new caller context which is a clone of the specified context and sets it as the current one.
(Inherited from ApiControllerBase.)
Protected methodEnsureFormFileMultipartContent
Ensures when form files are access the content is MIME multi-part which we want.
(Inherited from ApiControllerBase.)
Public methodGenerateDownloadFile
Generates a download file for the specified accounts.
Public methodGetAccountById
Gets a user account.
Public methodGetAccountByName
Gets a user account.
Public methodGetAccountInfoById
Gets the account info for the account ID.
Public methodGetAccountInfoByName
Gets the account by name.
Protected methodGetClientIdFromCookieOrProvided
Gets the client ID from cookie or from the provided value, which is usually from the query string.
(Inherited from ApiControllerBase.)
Protected methodGetService<T>
Gets the requested service.
(Inherited from ApiControllerBase.)
Protected methodGetSessionIdFromCookieHeaderOrProvided
Gets the session ID from cookie, the authorization header or from the provided value, which is usually from the query string.
(Inherited from ApiControllerBase.)
Public methodGetUserData
Gets the user data for the specified account.
Public methodImport
Imports accounts from a properly formatted accounts file. This API call expects form files inside the request body.
Protected methodLoadSession
Creates a new caller context associated with the specified session ID. The session is not validated.
(Inherited from ApiControllerBase.)
Public methodPromoteVirtualAccount
Promotes the virtual account to a non-virtual account.
Public methodQueryAccountInfos
Gets information about multiple user accounts.
Public methodQueryAccounts
Gets multiple user accounts.
Public methodQueryNumberOfAccounts
Gets the number of accounts that match the filter.
Public methodRefreshAccountPropertiesFromActiveDirectory
Refreshes the values of account properties from Active Directory (e.g. email address, display name).
Public methodRemoveFromTenants
Removes the account from the specified tenants.
Protected methodRequestFirstFormFile
Retrieves the first form file from the request.
(Inherited from ApiControllerBase.)
Protected methodRequestFormFiles
Retrieves the form files from the request.
(Inherited from ApiControllerBase.)
Protected methodReturnInvalidWindowsIdentityResponse
Returns the invalid windows identity response to challenge the browser.
(Inherited from ApiControllerBase.)
Public methodUpdateAccount
Updates a user account.
Public methodUpdateCustomAttributesForAccount
Updates the custom attributes for the specified account.
Public methodUpdateLastLogOnIpAddress
Updates a user account's last logon IP address.
Public methodValidAccountTypes
Gets a list of the account types that are currently relevant for the application.
Public methodValidatePassword
Validates the password against the current password policy.
Public methodWriteUserData
Writes user data in the account.
Top
Fields
  NameDescription
Public fieldStatic memberExportFilePrefix
Export file prefix.
Top
See Also