Understanding Actuate Information Delivery API operations : About Actuate Information Delivery API operations : Working with users, roles, and security
 
Working with users, roles, and security
User, role, and security functions support the ability to create, delete, or query user and role capabilities. Security and authentication operations manage user access to files, folders, channels, licenses, and other items in an Encyclopedia volume. These operations also authenticate and log in the user or Encyclopedia volume administrator.
iHub does not support using nested parent or child roles with pass-through security. When associating pass-through security with an Encyclopedia volume security role, the role must have only individual users as members. For example, if the security roles Supervisor and Manager are defined externally, the Supervisor security role cannot be a child of the Manager security role.
Table 3‑9 lists the operations that work with users, roles, and security.
Table 3‑9 Operations for working with users, roles, and security
Operation
Description
CallOpenSecurityLibrary
Calls the Report Server Security Extension (RSSE) API AcRSSEPassThrough function or PassThrough message, which calls the RSSE for general purposes.
CreateRole
Creates a security role in the Encyclopedia volume.
CreateRole is accessed through the Administrate operation.
CreateUser
Creates a user in the Encyclopedia volume.
CreateUser is accessed through the Administrate operation.
DeleteRole
Deletes one or more security roles. The request must specify whether to delete a single security role, a list of security roles, or security roles that match specific conditions.
DeleteRole is accessed through the Administrate operation.
DeleteUser
Deletes one or more users. The request must specify whether to delete a single user, a user list, or users that match specific conditions.
DeleteUser is accessed through the Administrate operation.
GetChannelACL
Retrieves the access control list (ACL) for a specified channel. Use either a name or ID to identify channels. FetchHandle supports retrieving a large list in the response
GetConnectionProperty
Assignees
Retrieves the users and roles for a file.
GetFileACL
Retrieves the ACL for a file or folder identified by either name or ID. FetchHandle supports retrieving a large list in the response.
GetFileCreationACL
Retrieves the user’s ACL templates, which are the privileges applied when the user creates a file or folder in an Encyclopedia volume. The client can specify the user either by name or ID.
GetUserLicenseOptions
Retrieves the license options for a specific user.
Login
Authenticates a user to BIRT iHub. Requires a user name. Can also accept a password or other credentials. Always returns an AuthId for use in subsequent requests in the same session. Always returns a list of the Actuate features the user can access. Can also return the user’s viewing preferences, valid security roles, and other user information. If the user is an Encyclopedia volume administrator, returns a list of the user’s administrative privileges.
SelectRoles
Retrieves a list of roles, roles that match specific conditions, or a single role.
SelectUsers
Retrieves a list of users, users that match specific conditions, or a single user.
SetConnectionProperties
Sets the connection properties for a file based on user or role.
SystemLogin
Authenticates the system administrator in BIRT iHub. Requires a system password. Returns an AuthId for use in subsequent requests in the same session.
UpdateOpenSecurityCache
Flushes the Encyclopedia volume’s open security data and retrieves new data from an external security source. Use UpdateOpenSecurityCache to retrieve new data before the existing data expires.
UpdateOpenSecurityCache is accessed through the Administrate operation.
UpdateRole, UpdateRoleOperation, UpdateRoleOperationGroup
Updates security role properties in the Encyclopedia volume. The request must specify the update activity to apply, such as updating general properties, and adding a user to one or more roles. It must also specify whether the activity applies to a single security role, a role list, or roles that match specific conditions.
UpdateRole is accessed through the Administrate operation.
UpdateUser, UpdateUserOperation, UpdateUserOperationGroup
Updates user properties in the Encyclopedia volume. The request must specify the update task to perform, such as updating general properties, and adding the user to a notification group. It must also specify whether the task applies to a single user, a user list, or users that match specific conditions.
UpdateUser is accessed through the Administrate operation.