All the capabilities provided by Administration Services for administering security are available through the Essbase API. To fully understand the workings of the security system, refer to the Oracle Essbase Database Administrator's Guide.
Many of the functions that use the security system require certain privileges to be available to the logged in user and return errors if an attempt is made to change security information without the correct authority. Typically, the logged in user should have Administrator or Application or Database Manager privileges, but you should be aware of possible problems if you are using the security functions and should plan for such errors, particularly during your initial testing.
To create or delete users or groups in Essbase, use EsxCreateUser() and EsxDeleteUser(). To set a user's password, use EsxSetPassword(). To get a list of users on a server, use EsxListUsers().
To get and set a user's or a group's security information, call EsxGetUser() and EsxSetUser().
To get and set the list of users that are members of a group (or the list of groups to which a member belongs), call EsxGetGroupList() and EsxSetGroupList().
To get user access privileges to an application, call EsxGetApplicationAccess().
The security functions can return the names of all the users who have access to a named application, all the applications to which a named user has access, or the access level of a specific application-user combination. A similar function exists for databases, and corresponding Set functions exist for setting application and database access.
To get the contents of a named security filter, first call EsxGetFilter() then repeat calls to EsxGetFilterRow() (to get each row description in the filter) until a NULL string is returned. To set the contents of a filter, first call EsxSetFilter(), and then repeat calls to EsxSetFilterRow() until all rows have been sent (send a NULL row pointer to terminate the sequence).
To get a list of the named filters in a database, call EsxListFilters(). To get a list of users who are assigned a named filter, use EsxGetFilterList().
For detailed descriptions of the security-related functions, see C Main API Security Filter Functions and VB Main API Security Filter Functions.