SecurityService Service

Use the SecurityService service to provide methods for identifying accounts and privileges.

Method Names	Description
forgetAccountsEx() Method	Removes accounts from the catalog.
getAccounts() Method	Searches for Oracle Analytics user accounts.
getGlobalPrivilegeACL() Method	Gets the Access Control List for global privileges.
getGlobalPrivileges() Method	Gets the list of all global privileges.
getPermissions() Method	Get the list of permissions for the specified user.
getPermissionsEx() Method	Get the list of permissions for the specified user.
getPrivilegesStatus() Method	Lists all privileges and their statuses.
renameAccountsEx() Method	Changes the name of an user account.
updateGlobalPrivilegeACL() Method	Updates the Access Control List for global privileges.

forgetAccountsEx() Method

Use the forgetAccountsEx() method to remove accounts from the catalog.

Signature

forgetAccountsStatus forgetAccountsEx(ForgetAccount forgetAccountsList, String sessionID);

Argument	Description
ForgetAccount forgetAccountsList	Specifies the accounts to forget, supplied in the ForgetAccount structure. For information about the ForgetAccount structure, see ForgetAccount Structure.
String sessionID	Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.

Returns

Returns a list of account names with status of forgetAccounts operation in the ForgetAccountsStatus Structure.

See ForgetAccountsStatus Structure.

getAccounts() Method

Use the getAccounts() method to search for Oracle Analytics user accounts (for example, LDAP users, catalog groups, or application roles).

Signature

List[] getAccounts(List[], String sessionID);

Argument	Description
List[]	Specifies user names, catalog group names, and application role names. A flag indicates if the name is a user, group, or application role.
String sessionID	Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.

getGlobalPrivilegeACL() Method

Use the getGlobalPrivilegeACL() method to retrieve the Access Control List for global privileges.

Signature

ACL getGlobalPrivilegeACL(String privilegeName, String sessionID);

Argument	Description
String privilegeName	Specifies the name of the privilege to retrieve.
String sessionID	Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.

getGlobalPrivileges() Method

Use the getGlobalPrivileges() method to retrieve the list of global privileges.

Signature

List[] getGlobalPrivileges(String sessionID);

Argument	Description
String sessionID	Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.

getPermissions() Method

Use the getPermissions() method to retrieve a list of permissions for the specified user, based on the specified access control list.

This method also returns any permissions that are inherited by a user's security group, even if the access control list doesn't specify the group's permissions.

Signature

List[] getPermissions(List[], Account account, String sessionID);

Argument	Description
List[]	Specifies the access control list for the user specified by Account account.
Account account	Specifies the name of the user for whom to find permission for the ACLs. Can be the user's name or a GUID.
String sessionID	Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.

Returns

Returns permissions information in the permissionMask field in the AccessControlToken structure.

See AccessControlToken Structure).

getPermissionsEx() Method

Use the getPermissionsEx() method to retrieve a list of permissions for the specified user, owner, or creator, based on the specified access control list.

Signature

List[] getPermissionsEx(List[], Account account, Owner owner, Creator creator, String sessionID);

Argument	Description
List[]	Specifies the access control list for the user specified by Account account.
Account account	Specifies the name of the user for whom to find permission for the ACLs. Can be the user's name or a GUID.
Owner owner	Specifies the name of the owner for whom to find permission for the ACLs. Can be the owner's user name or a GUID.
Creator creator	Specifies the name of the creator for whom to find permission for the ACLs. Can be the creator's user name or a GUID.
String sessionID	Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.

Returns

Returns permissions information in the permissionMask field in the AccessControlToken structure.

See AccessControlToken Structure).

getPrivilegesStatus() Method

Use the getPrivilegesStatus() method to list all privileges and their statuses.

Signature

List[] getPrivilegesStatus(List[] privileges, String sessionID);

Argument	Description
List[] privileges	Specifies a list of privileges.
String sessionID	Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.

renameAccountsEx() Method

Use the renameAccountsEx() method to rename accounts.

Signature

RenameAccountsStatus renameAccountsStatusEx(RenameAccount renameAccountsList, String sessionID);

Argument	Description
RenameAccount renameAccountsList	Specifies a list of old names and new names with their account types in the RenameAccount structure. For information about the RenameAccount structure, see RenameAccountsStatus Structure
String sessionID	Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.

Returns

Returns a list of account names with status of renameAccounts operation in the RenameAccountsStatus Structure.

See RenameAccountsStatus Structure.

updateGlobalPrivilegeACL() Method

Use the updateGlobalPrivilegeACL() method to update the Access Control List for global privileges.

Signature

void updateGlobalPrivilegeACL(String privilegeName, ACL acl, UpdateACLParams updateACLParams, String sessionID);

Arguments	Description
String privilegeName	Specifies the name of privilege to update.
ACL acl	Specifies the Access Control List to update, supplied in the ACL structure. For information about the ACL structure, see ACL Structure.
UpdateACLParams updateACLParams	Specifies the Access Control List parameters to update, supplied in the UpdateACLParams structure. For information about the UpdateACLParams structure, see UpdateACLParams Structure.
String sessionID	Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.