AccountController Class

The REST API for performing administration tasks on an account.

Inheritance Hierarchy

SystemObject
  Microsoft.AspNetCore.MvcControllerBase
    Dundas.BI.WebApi.ControllersApiControllerBase
      Dundas.BI.WebApi.ControllersAccountController

Namespace: Dundas.BI.WebApi.Controllers
Assembly: Dundas.BI.WebApi (in Dundas.BI.WebApi.dll) Version: 2.0.0.0 (25.4.0.1000)

Syntax

C++

Copy

public class AccountController : ApiControllerBase

Public Class AccountController
	Inherits ApiControllerBase

public ref class AccountController : public ApiControllerBase

type AccountController =  
    class
        inherit ApiControllerBase
    end

The AccountController type exposes the following members.

Constructors

	Name	Description
	AccountController	Initializes a new instance of the AccountController class.

Top

Methods

	Name	Description
	AddToTenants	Adds the account to the specified tenants.
	ChangePassword	Updates the password for the current account, or if an account ID is specified, the password for the specified account.
	ClearExternalGroupCache	Clears the external group cache for the specified account.
	ConvertAllWindowsAccountsToLocalAccounts	Converts a Windows all user/group accounts to a accounts.
	ConvertWindowsAccountToExternalAccount	Converts a Windows user/group account to an External user/group account.
	ConvertWindowsAccountToLocalAccount	Converts a Windows user/group account to a local account.
	CreateAccount	Creates a user account of the requested type.
	DeleteAccount	Deletes an account.
	Download	Gets the requested download as a binary stream.
	EnsureCallerContext	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.)
	EnsureFormFileMultipartContent	Ensures when form files are access the content is MIME multi-part which we want. (Inherited from ApiControllerBase.)
	GenerateDownloadFile	Generates a download file for the specified accounts.
	GetAccountById	Gets a user account.
	GetAccountByName	Gets a user account.
	GetAccountInfoById	Gets the account info for the account ID.
	GetAccountInfoByName	Gets the account by name.
	GetClientIdFromCookieOrProvided	Gets the client ID from cookie or from the provided value, which is usually from the query string. (Inherited from ApiControllerBase.)
	GetServiceT	Gets the requested service. (Inherited from ApiControllerBase.)
	GetSessionIdFromCookieHeaderOrProvided	Gets the session ID from cookie, the authorization header or from the provided value, which is usually from the query string. (Inherited from ApiControllerBase.)
	GetUserData	Gets the user data for the specified account.
	Import	Imports accounts from a properly formatted accounts file. This API call expects form files inside the request body.
	LoadSession	Creates a new caller context associated with the specified session ID. The session is not validated. (Inherited from ApiControllerBase.)
	PromoteVirtualAccount	Promotes the virtual account to a non-virtual account.
	QueryAccountInfos	Gets information about multiple user accounts.
	QueryAccounts	Gets multiple user accounts.
	QueryNumberOfAccounts	Gets the number of accounts that match the filter.
	RefreshAccountPropertiesFromActiveDirectory	Refreshes the values of account properties from Active Directory (e.g. email address, display name).
	RemoveFromTenants	Removes the account from the specified tenants.
	RequestFirstFormFile	Retrieves the first form file from the request. (Inherited from ApiControllerBase.)
	RequestFormFiles	Retrieves the form files from the request. (Inherited from ApiControllerBase.)
	ReturnInvalidWindowsIdentityResponse	Returns the invalid windows identity response to challenge the browser. (Inherited from ApiControllerBase.)
	UpdateAccount	Updates a user account.
	UpdateCustomAttributesForAccount	Updates the custom attributes for the specified account.
	UpdateLastLogOnIpAddress	Updates a user account's last logon IP address.
	ValidAccountTypes	Gets a list of the account types that are currently relevant for the application.
	ValidatePassword	Validates the password against the current password policy.
	WriteUserData	Writes user data in the account.

Top

Fields

	Name	Description
	ExportFilePrefix	Export file prefix.

Top

Reference

Dundas.BI.WebApi.Controllers Namespace