com.vasoftware.sf.soap44.webservices.rbac
Interface IRbacAppSoap

public interface IRbacAppSoap

SOAP APIs for Role Based Access Control (RBAC).

Change History

Version 4.4

• addCluster2: Operation removed in 4.4. Use addCluster instead
• addCluster: Operation modified in 4.4 to remove parameter resourceName
• deleteRole: New operation added in 4.4
• removeCluster: New operation added in 4.4
• listClusters: New operation added in 4.4

Since:

4.1-HOTFIX4

Method Summary

void	addCluster(java.lang.String sessionId, java.lang.String roleId, java.lang.String operationCluster, java.lang.String folderId) Add an operation cluster to a role, expanding the permission set that the role grants access to.
void	addUser(java.lang.String sessionId, java.lang.String roleId, java.lang.String username) Add a user to the role, giving them all of the permissions of that role
RoleSoapDO	createRole(java.lang.String sessionId, java.lang.String projectId, java.lang.String title, java.lang.String description) Create a role in a given project
void	deleteRole(java.lang.String sessionId, java.lang.String roleId) Delete a role.
RoleSoapList	getRoleList(java.lang.String sessionId, java.lang.String projectId) Get a list of Roles in a project context.
UserSoapList	getRoleMemberList(java.lang.String sessionId, java.lang.String roleId) Returns a list of users that are in a specified role.
RoleSoapList	getUserRoleList(java.lang.String sessionId, java.lang.String projectId, java.lang.String username) Returns a list of roles that a user is a member of in the specified project.
RoleClusterSoapList	listClusters(java.lang.String sessionId, java.lang.String roleId) Get the list of operation cluster assigned to a role.
void	removeCluster(java.lang.String sessionId, java.lang.String roleId, java.lang.String operationCluster, java.lang.String folderId) Remove an operation cluster to a role, removing the permission set.
void	removeUser(java.lang.String sessionId, java.lang.String roleId, java.lang.String username) Remove a user from a role

Method Detail

createRole

RoleSoapDO createRole(java.lang.String sessionId,
                      java.lang.String projectId,
                      java.lang.String title,
                      java.lang.String description)
                      throws java.rmi.RemoteException

Create a role in a given project

Parameters:

sessionId - User session Id

projectId - The project Id to create the role in

title - The title of the role

description - A description of the role

Returns:

The RoleSoapDO that was created

Throws:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - If the session is invalid

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - If the user doesn't have permission to perform the operation

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system level error occurs.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - When the projectId is invalid

com.vasoftware.sf.soap44.fault.ObjectAlreadyExistsFault - If the role exists with the specified title in the project

com.vasoftware.sf.soap44.fault.IllegalArgumentFault - If one of the parameters is invalid

java.rmi.RemoteException

Since:

4.1-HOTFIX4

deleteRole

void deleteRole(java.lang.String sessionId,
                java.lang.String roleId)
                throws java.rmi.RemoteException

Delete a role.

Parameters:

sessionId - User session Id

roleId - The role id to add the cluster to

Throws:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - If the session is invalid

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - If the user doesn't have permission to perform the operation

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system level error occurs.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - When the projectId is invalid

java.rmi.RemoteException

Since:

4.4

addCluster

void addCluster(java.lang.String sessionId,
                java.lang.String roleId,
                java.lang.String operationCluster,
                java.lang.String folderId)
                throws java.rmi.RemoteException

Add an operation cluster to a role, expanding the permission set that the role grants access to.

Parameters:

sessionId - User session Id

roleId - The role id to add the cluster to

operationCluster - The cluster name to add to the role. See OperationClusterConstants.

folderId - the folder id for the specified cluster. Pass in empty string to apply to all folders of the same type in the project. Note that passing in an empty folder id will not replace existing folder specific clusters.

Throws:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - If the session is invalid

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - If the user doesn't have permission to perform the operation

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system level error occurs.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - When the roleId is invalid

com.vasoftware.sf.soap44.fault.ObjectAlreadyExistsFault - If the cluster already exists in the role

com.vasoftware.sf.soap44.fault.IllegalArgumentFault - If one of the parameters is invalid

java.rmi.RemoteException

Since:

4.4

removeCluster

void removeCluster(java.lang.String sessionId,
                   java.lang.String roleId,
                   java.lang.String operationCluster,
                   java.lang.String folderId)
                   throws java.rmi.RemoteException

Remove an operation cluster to a role, removing the permission set.

Parameters:

sessionId - User session Id

roleId - The role id to remove the cluster to

operationCluster - The cluster name to add to the role

folderId - the folder id for the specified cluster. Pass in empty string to remove a cluster defined for all folders. Note that passing in an empty folder id will not remove existing folder specific clusters.

Throws:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - If the session is invalid

com.vasoftware.sf.soap44.fault.IllegalArgumentFault - If one of the parameters is invalid

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - If the user doesn't have permission to perform the operation

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system level error occurs.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - When the roleId is invalid

java.rmi.RemoteException

Since:

4.4

listClusters

RoleClusterSoapList listClusters(java.lang.String sessionId,
                                 java.lang.String roleId)
                                 throws java.rmi.RemoteException

Get the list of operation cluster assigned to a role.

Parameters:

sessionId - User session Id

roleId - The role id to remove the cluster to

Returns:

list of clusters for a role

Throws:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - If the session is invalid

com.vasoftware.sf.soap44.fault.IllegalArgumentFault - If one of the parameters is invalid

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - If the user doesn't have permission to perform the operation

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system level error occurs.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - When the roleId is invalid

java.rmi.RemoteException

Since:

4.4

addUser

void addUser(java.lang.String sessionId,
             java.lang.String roleId,
             java.lang.String username)
             throws java.rmi.RemoteException

Add a user to the role, giving them all of the permissions of that role

Parameters:

sessionId - User sessionId

roleId - The role id to add the user to

username - The username of the user to add to the role

Throws:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - If the session is invalid

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - If the user doesn't have permission to perform the operation

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system level error occurs.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - When the roleId is invalid

com.vasoftware.sf.soap44.fault.ObjectAlreadyExistsFault - If the user already exists in the role

com.vasoftware.sf.soap44.fault.IllegalArgumentFault - If one of the parameters is invalid

java.rmi.RemoteException

Since:

4.1-HOTFIX4

removeUser

void removeUser(java.lang.String sessionId,
                java.lang.String roleId,
                java.lang.String username)
                throws java.rmi.RemoteException

Remove a user from a role

Parameters:

sessionId - User sessionId

roleId - The role id to add the user to

username - The username of the user to add to the role

Throws:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - If the session is invalid

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - If the user doesn't have permission to perform the operation

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system level error occurs.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - When the roleId is invalid

com.vasoftware.sf.soap44.fault.IllegalArgumentFault - If one of the parameters is invalid

java.rmi.RemoteException

Since:

4.3-HOTFIX1

getRoleList

RoleSoapList getRoleList(java.lang.String sessionId,
                         java.lang.String projectId)
                         throws java.rmi.RemoteException

Get a list of Roles in a project context. This call required project admin permissions.

Parameters:

sessionId - User session Id

projectId - The project Id to list roles from

Returns:

The RoleSoapList describing all roles in the project

Throws:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - If the session is invalid

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - If the user doesn't have permission to perform the operation

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system level error occurs.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - When the projectId is invalid

com.vasoftware.sf.soap44.fault.ObjectAlreadyExistsFault - If the role exists with the specified title in the project

com.vasoftware.sf.soap44.fault.IllegalArgumentFault - If one of the parameters is invalid

java.rmi.RemoteException

Since:

4.3

getRoleMemberList

UserSoapList getRoleMemberList(java.lang.String sessionId,
                               java.lang.String roleId)
                               throws java.rmi.RemoteException

Returns a list of users that are in a specified role.

Parameters:

sessionId - User session id.

roleId - Role id.

Returns:

List of users in the specified role.

Throws:

com.vasoftware.sf.soap44.fault.IllegalArgumentFault - Role id is not specified or invalid.

com.vasoftware.sf.soap44.fault.InvalidSessionFault - if the session is invalid.

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - if the user does not have permission to perform the operation

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified role id is invalid

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system level error occurs.

java.rmi.RemoteException

Since:

4.3-SP1

getUserRoleList

RoleSoapList getUserRoleList(java.lang.String sessionId,
                             java.lang.String projectId,
                             java.lang.String username)
                             throws java.rmi.RemoteException

Returns a list of roles that a user is a member of in the specified project.

Parameters:

sessionId - User session id.

projectId - Project id.

username - Name of the user.

Returns:

List of roles that a user is a member of.

Throws:

com.vasoftware.sf.soap44.fault.IllegalArgumentFault - Username is not specified or invalid.

com.vasoftware.sf.soap44.fault.InvalidSessionFault - if the session is invalid.

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - if the user does not have permission to perform the operation

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified project id is invalid

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system level error occurs.

java.rmi.RemoteException

Since:

4.3-SP1