Bookshelf v7.8.2: SecurityService

Siebel Analytics Web Administration Guide > Working with Data and Managing the Web Catalog Using Siebel Analytics Web SOAP API > Description of Siebel Analytics Web SOAP API Methods >

SecurityService

Provides methods for identifying accounts and privileges. Table 51 shows the supported methods.

Table 51. SecurityService Methods
Method Names	Description
forgetAccount() Method	Removes a Siebel Analytics Web internal ID to account name mapping.
getGlobalPrivilegeACL() Method	Get the Access Control List for global privileges.
getGlobalSAWPrivileges() Method	Get the list of all global privileges.
updateGlobalPrivilegeACL() Method	Update the Access Control List for global privileges.

forgetAccount() Method

Removes a Siebel Analytics Web internal ID to account name mapping. This is useful when an account mapping was created by mistake, for example as a side effect of an updateGlobalSAWPrivilegeACL call with a misspelled account name.

Signature

void forgetAccount(Account account);


Argument	Description
Account account	The accounts to forget, supplied in the Account structure. For information about the Account structure, see Account Structure.

getGlobalPrivilegeACL() Method

Get the Access Control List for global privileges.

Signature

ACL getGlobalPrivilegeACL(String privilegeName, String sessionID);


Argument	Description
String privilegeName	String containing the name of privilege to get.
String sessionID	A string value that contains the session ID to log off from the SOAP session. The session ID is usually returned by the logon call. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.

Returns

Returns the Access Control List in an ACL structure. For more information on the ACL structure, see ACL Structure.

getGlobalSAWPrivileges() Method

Get the list of all global privileges.

Signature

Privilege[] getGlobalSAWPrivileges(String sessionID);


Argument	Description
String sessionID	A string value that contains the session ID to log off from the SOAP session. The session ID is usually returned by the logon call. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.

Returns

Returns privilege information in a Privilege structure. For more information on the Privilege structure, see Privilege Structure.

updateGlobalPrivilegeACL() Method

Update the Access Control List for global privileges.

Signature

void updateGlobalPrivilegeACL(String SAWPrivilegeName, ACL acl, UpdateACLParams options, String sessionID);


Arguments	Description
String SAWPrivilegeName	String containing the name of privilege to update.
ACL acl	The Access Control List to update, supplied in the ACL structure. For information about the ACL structure, see ACL Structure.
UpdateACLParams options	The Access Control List parameters to update, supplied in the UpdateACLParams structure. For information about the UpdateACLParams structure, see UpdateACLParams Structure.
String sessionID	A string value that contains the session ID to log off from the SOAP session. The session ID is usually returned by the logon call. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.