Package com.collabnet.ce.soap60.webservices.rbac

Interface IRbacAppSoap

All Known Implementing Classes:

RbacAppSoap, RbacAppSoapMockStub, RbacAppSoapStub

public interface IRbacAppSoap

Method Summary

Modifier and Type	Method	Description
void	addCluster(String sessionId, String roleId, String operationCluster, String folderId)	Adds an operation cluster to a role, expanding the permission set that the role grants access to.
void	addGroup(String sessionId, String groupId, String roleId, String projectOrProjectGroupId)	Adds a user group to a role, within the Project/ProjectGroup scope.
void	addIntegratedApplicationPermission(String sessionId, String roleId, String integratedAppName, String permission)	Adds an integrated application permission to a role, expanding the permission set that the role grants access to.
void	addUser(String sessionId, String roleId, String username)	Adds a user to the role, giving them all of the permissions of that role
void	addUserToProjectRole(String sessionId, String roleId, String username, String projectOrProjectGroupId)	Adds a user to the role in the given project context
void	approveRoleRequest(String sessionId, String requestId, String projectId)	Approves a role request
RoleSoapDO	createGlobalRole(String sessionId, String title, String description, boolean preventInheritance, boolean requestable)	Creates a global role.
RoleSoapDO	createRole(String sessionId, String projectOrProjectGroupId, String title, String description, boolean preventInheritance, boolean requestable, boolean autoGrant)	Creates a role in a given project
RoleSoapDO	createSiteWideRole(String sessionId, String title, String description, boolean preventInheritance)	Creates a site-wide role.
void	deleteRole(String sessionId, String roleId)	Deletes a role.
boolean	getAutomaticallyGrantOnRequest(String sessionId, String roleId, String projectId)	Gets the role's Automatically Grant On Request for the given project.
RoleSoapList	getGlobalRoleList(String sessionId)	Returns a list of all the global roles available on the site.
RoleSoapList	getGlobalRolesForAssignment(String sessionId, String projectOrProjectGroupId)	Returns a list of global roles available in the project or project group for user/user group assignment.
RoleSoapList	getGroupRoleList(String sessionId, String groupId, String projectIdOrProjectGroupId)	Returns a list of roles the user group is associated with in a project or projectGroup.
RoleSoapList	getInheritedRoleList(String sessionId, String projectId)	Gets a list of roles inherited from any of the parent projects.
IntegratedAppProjectPermissionSoapList	getIntegratedAppPermissions(String sessionId, String[] projectIds, String baseUrl)	Returns list of integratedApp permissions for the user associated with specified projects
String[]	getIntegratedAppPermissionsForProject(String sessionId, String projectId, String linkId)	Returns integratedApp permissions for the user associated with a project
RoleRequestSoapList	getPendingRequestedRoles(String sessionId, String projectId)	Lists the pending requested roles for the given projectId
UserSoapList	getProjectRoleMemberList(String sessionId, String roleId, String projectOrProjectGroupId)	Returns a list of users that are in a specified role in the given project or project group.
String[]	getProjectsByIntegratedAppPermission(String sessionId, String perm, String integratedAppName)	Returns the list of projects by integratedApp permission.
ProjectSoapList	getProjectsForAction(String sessionId, String operationString, String userName)	Gets the list of all projects in which the given user has given permission.
RoleSoapDO	getRoleData(String sessionId, String roleId)	Get a role data.
UserGroupSoapList	getRoleGroupList(String sessionId, String roleId)	Returns a list of user groups that belong to the specified role.
UserSoapList	getRoleGroupUsers(String sessionId, String projectIdOrProjectGroupId, String roleId)	Returns a list of users who are part of a group and associated with the specified role.
RoleSoapList	getRoleList(String sessionId, String projectOrProjectGroupId)	Gets a list of Roles in a project context.
UserSoapList	getRoleMemberList(String sessionId, String roleId)	Returns a list of users that are assigned to the specified role.
RoleSoapList	getSiteWideRoleList(String sessionId)	Returns a list of all the site-wide roles available on the site.
RoleSoapList	getUserRoleList(String sessionId, String projectOrProjectGroupId, String username)	Returns a list of roles that a user is a member of in the specified project or project group.
RoleSoapList	getUserSiteWideRoleList(String sessionId, String username)	Returns a list of roles that a user is a member of site wide role.
void	grantRolesToMembers(String sessionId, UserRolesSoapDO[] userRolesSoapDOs, String projectId)	Grants roles to list of users in a given project and user is made as member of the project if not already.
RoleCluster2SoapList	listClusterForDefaultAccessPermissions(String sessionId, String projectId)	Gets the list of operation cluster with default access permission.
RoleClusterSoapList	listClusters(String sessionId, String roleId)	Gets the list of operation cluster assigned to a role.
RoleGroupSoapList	listGroupRolesByProject(String sessionId, String projectId)	Returns a list of user groups and the roles it is associated with in a project.
RoleGroupSoapList	listGroupRolesByProjectGroup(String sessionId, String projectGroupId)	Returns a list of user groups and the roles it is associated with in a project group.
SoapNamedValues	listRolePaths(String sessionId, String roleId, String repositoryId)	Gets the list of paths for a role.
void	rejectRoleRequest(String sessionId, String requestId, String projectId)	Rejects a role request
void	removeCluster(String sessionId, String roleId, String operationCluster, String folderId)	Removes an operation cluster to a role, removing the permission set.
void	removeGroup(String sessionId, String groupId, String roleId, String projectOrProjectGroupId)	Removes the user group for the role, within the Project/ProjectGroup scope
void	removeIntegratedApplicationPermission(String sessionId, String roleId, String integratedAppName, String permission)	Removes an integrated application permission from the given role.
void	removeUser(String sessionId, String roleId, String username)	Removes a user from a role
void	removeUserFromProjectRole(String sessionId, String roleId, String username, String projectOrProjectGroupId)	Removes a user from a role in the given project
void	requestRole(String sessionId, String roleId, String projectId)	Requests a role
void	revokeRolesFromMembers(String sessionId, UserRolesSoapDO[] userRolesSoapDOs, String projectId)	Removes roles from users in the project
void	setAutomaticallyGrantOnRequest(String sessionId, String roleId, String projectId, boolean autoGrant)	Sets the role's Automatically Grant On Request for the given project.
void	setRoleData(String sessionId, RoleSoapDO roleData)	Saves a role object.
void	setRolePaths(String sessionId, String roleId, String repositoryId, SoapNamedValues rolePaths)	Sets the list of paths for a role.

Method Detail

createRole

RoleSoapDO createRole(String sessionId,
                      String projectOrProjectGroupId,
                      String title,
                      String description,
                      boolean preventInheritance,
                      boolean requestable,
                      boolean autoGrant)
               throws RemoteException

Creates a role in a given project

Parameters:

sessionId - User session Id

projectOrProjectGroupId - The project /project group Id to create the role in

title - The title of the role

description - A description of the role

preventInheritance - If the role's permission is prevented from applying to private subprojects.

requestable - If the role is available upon request

autoGrant - If the role is granted automatically on request

Returns:

The Role2SoapDO that was created

Throws:

InvalidSessionFault - If the session is invalid

PermissionDeniedFault - If the user doesn't have permission to perform the operation

SystemFault - when an unexpected system level error occurs.

NoSuchObjectFault - When the projectId is invalid or the created roleId is invalid.

ObjectAlreadyExistsFault - If the role exists with the specified title in the project

IllegalArgumentFault - If one of the parameters is invalid

RemoteException

Since:

4.1-HOTFIX4

createSiteWideRole

RoleSoapDO createSiteWideRole(String sessionId,
                              String title,
                              String description,
                              boolean preventInheritance)
                       throws RemoteException

Creates a site-wide role. Users with site-admin permissions

Parameters:

sessionId - User session Id

title - The title of the site-wide role

description - A description of the role

preventInheritance - If the role's permission is prevented from applying to private projects.

Returns:

The Role2SoapDO that was created

Throws:

InvalidSessionFault - If the session is invalid

PermissionDeniedFault - If the user doesn't have permission to perform the operation

SystemFault - when an unexpected system level error occurs.

NoSuchObjectFault - When the created roleId is invalid

ObjectAlreadyExistsFault - If the role exists with the specified title in the project

IllegalArgumentFault - If one of the parameters is invalid

RemoteException

Since:

6.0

createGlobalRole

RoleSoapDO createGlobalRole(String sessionId,
                            String title,
                            String description,
                            boolean preventInheritance,
                            boolean requestable)
                     throws RemoteException

Creates a global role. Only Super-users or users having Role-Create permission can create global role.

Parameters:

sessionId - User session Id

title - The title of the global role

description - The description of the global role

preventInheritance - If the role's permission is prevented from applying to private projects.

requestable - If the role is available upon request

Returns:

The Role2SoapDO that was created

Throws:

InvalidSessionFault - If the session is invalid

PermissionDeniedFault - If the user doesn't have permission to perform the operation

SystemFault - when an unexpected system level error occurs.

NoSuchObjectFault - When the created roleId is invalid

ObjectAlreadyExistsFault - If the global role exists with the specified title

IllegalArgumentFault - If one of the parameters is invalid

RemoteException

Since:

6.0

setRoleData

void setRoleData(String sessionId,
                 RoleSoapDO roleData)
          throws RemoteException

Saves a role object.

Parameters:

sessionId - User session Id

roleData - the role object to save

Throws:

InvalidSessionFault - If the session is invalid

VersionMismatchFault - The role version being edited is not the latest one

PermissionDeniedFault - If the user doesn't have permission to perform the operation

IllegalArgumentFault - If one of the parameters is invalid

NoSuchObjectFault - When the roleId is invalid

SystemFault - when an unexpected system level error occurs.

RemoteException

Since:

6.0

getRoleData

RoleSoapDO getRoleData(String sessionId,
                       String roleId)
                throws RemoteException

Get a role data.

Parameters:

sessionId - User session Id

roleId - The id of the role to be fetch

Returns:

The RoleSoapDO that was fetched

Throws:

InvalidSessionFault - If the session is invalid

PermissionDeniedFault - If the user doesn't have permission to perform the operation

NoSuchObjectFault - When the roleId is invalid

SystemFault - when an unexpected system level error occurs.

IllegalArgumentFault - When the roleId is invalid

RemoteException

Since:

8.0

deleteRole

void deleteRole(String sessionId,
                String roleId)
         throws RemoteException

Deletes a role.

Parameters:

sessionId - User session Id

roleId - The id of the role to be deleted

Throws:

InvalidSessionFault - If the session is invalid

PermissionDeniedFault - If the user doesn't have permission to perform the operation

SystemFault - when an unexpected system level error occurs.

NoSuchObjectFault - When the projectId is invalid

RemoteException

Since:

4.4

addCluster

void addCluster(String sessionId,
                String roleId,
                String operationCluster,
                String folderId)
         throws RemoteException

Adds 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.

Throws:

InvalidSessionFault - If the session is invalid

PermissionDeniedFault - If the user doesn't have permission to perform the operation

SystemFault - when an unexpected system level error occurs.

NoSuchObjectFault - When the roleId is invalid

ObjectAlreadyExistsFault - If the cluster already exists in the role

IllegalArgumentFault - If one of the parameters is invalid

RemoteException

Since:

4.4

addIntegratedApplicationPermission

void addIntegratedApplicationPermission(String sessionId,
                                        String roleId,
                                        String integratedAppName,
                                        String permission)
                                 throws RemoteException

Adds an integrated application permission 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 integrated application permission to

integratedAppName - The integrated application name (e.g: 'Pebble Blog')

permission - The integrated application permission name to add to the role.

Throws:

InvalidSessionFault - If the session is invalid

PermissionDeniedFault - If the user doesn't have permission to perform the operation

SystemFault - when an unexpected system level error occurs.

NoSuchObjectFault - When the roleId is invalid

ObjectAlreadyExistsFault - If the cluster already exists in the role

IllegalArgumentFault - If one of the parameters is invalid

RemoteException

Since:

8.0

removeIntegratedApplicationPermission

void removeIntegratedApplicationPermission(String sessionId,
                                           String roleId,
                                           String integratedAppName,
                                           String permission)
                                    throws RemoteException

Removes an integrated application permission from the given role.

Parameters:

sessionId - User session Id

roleId - The role id from which the integrated application permission to be removed

integratedAppName - The integrated application name (e.g: 'Pebble Blog')

permission - The integrated application permission to be removed from the role.

Throws:

InvalidSessionFault - If the session is invalid

PermissionDeniedFault - If the user doesn't have permission to perform the operation

SystemFault - when an unexpected system level error occurs.

NoSuchObjectFault - When the roleId is invalid

ObjectAlreadyExistsFault - If the cluster already exists in the role

IllegalArgumentFault - If one of the parameters is invalid

RemoteException

Since:

17.8

removeCluster

void removeCluster(String sessionId,
                   String roleId,
                   String operationCluster,
                   String folderId)
            throws RemoteException

Removes 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.

Throws:

InvalidSessionFault - If the session is invalid

IllegalArgumentFault - If one of the parameters is invalid

PermissionDeniedFault - If the user doesn't have permission to perform the operation

SystemFault - when an unexpected system level error occurs.

NoSuchObjectFault - When the roleId is invalid

RemoteException

Since:

4.4

listClusters

RoleClusterSoapList listClusters(String sessionId,
                                 String roleId)
                          throws RemoteException

Gets the list of operation cluster assigned to a role.

Parameters:

sessionId - User session Id

roleId - The ID of the role for which clusters will be listed

Returns:

list of clusters for a role

Throws:

InvalidSessionFault - If the session is invalid

IllegalArgumentFault - If one of the parameters is invalid

PermissionDeniedFault - If the user doesn't have permission to perform the operation

SystemFault - when an unexpected system level error occurs.

NoSuchObjectFault - When the roleId is invalid

RemoteException

Since:

4.4

listClusterForDefaultAccessPermissions

RoleCluster2SoapList listClusterForDefaultAccessPermissions(String sessionId,
                                                            String projectId)
                                                     throws RemoteException

Gets the list of operation cluster with default access permission.

Parameters:

sessionId - User session Id

projectId - The ID of the project for which clusters will be listed

Returns:

list of clusters for a project

Throws:

InvalidSessionFault - If the session is invalid

IllegalArgumentFault - If one of the parameters is invalid

NoSuchObjectFault - When the roleId is invalid

SystemFault

PermissionDeniedFault

RemoteException

Since:

8.0

addUser

void addUser(String sessionId,
             String roleId,
             String username)
      throws RemoteException

Adds 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:

InvalidSessionFault - If the session is invalid

PermissionDeniedFault - If the user doesn't have permission to perform the operation

SystemFault - when an unexpected system level error occurs.

NoSuchObjectFault - When the roleId is invalid

ObjectAlreadyExistsFault - If the user already exists in the role

IllegalArgumentFault - If one of the parameters is invalid

RemoteException

Since:

4.1-HOTFIX4

grantRolesToMembers

void grantRolesToMembers(String sessionId,
                         UserRolesSoapDO[] userRolesSoapDOs,
                         String projectId)
                  throws RemoteException

Grants roles to list of users in a given project and user is made as member of the project if not already.

Parameters:

sessionId - User sessionId

userRolesSoapDOs - user to roles data container

projectId - project to which users would be the members with the given roles.

Throws:

InvalidSessionFault - If the session is invalid

PermissionDeniedFault - If the user doesn't have permission to perform the operation

SystemFault - when an unexpected system level error occurs.

NoSuchObjectFault - When the roleId is invalid

ObjectAlreadyExistsFault - If the user already exists in the role

IllegalArgumentFault - If one of the parameters is invalid

RemoteException

Since:

6.0

removeUser

void removeUser(String sessionId,
                String roleId,
                String username)
         throws RemoteException

Removes 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:

InvalidSessionFault - If the session is invalid

PermissionDeniedFault - If the user doesn't have permission to perform the operation

SystemFault - when an unexpected system level error occurs.

NoSuchObjectFault - When the roleId is invalid

IllegalArgumentFault - If one of the parameters is invalid

RemoteException

Since:

4.3-HOTFIX1

revokeRolesFromMembers

void revokeRolesFromMembers(String sessionId,
                            UserRolesSoapDO[] userRolesSoapDOs,
                            String projectId)
                     throws RemoteException

Removes roles from users in the project

Parameters:

sessionId - User sessionId

userRolesSoapDOs - user to roles data container

projectId - project in which roles would be removed from the users.

Throws:

InvalidSessionFault - If the session is invalid

PermissionDeniedFault - If the user doesn't have permission to perform the operation

SystemFault - when an unexpected system level error occurs.

NoSuchObjectFault - When the roleId is invalid

IllegalArgumentFault - If one of the parameters is invalid

RemoteException

Since:

6.0

addUserToProjectRole

void addUserToProjectRole(String sessionId,
                          String roleId,
                          String username,
                          String projectOrProjectGroupId)
                   throws RemoteException

Adds a user to the role in the given project context

Parameters:

sessionId - User sessionId

roleId - The role id to add the user to

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

projectOrProjectGroupId - projectId (or) Project group ID.

Throws:

InvalidSessionFault - If the session is invalid

PermissionDeniedFault - If the user doesn't have permission to perform the operation

SystemFault - when an unexpected system level error occurs.

NoSuchObjectFault - When the roleId is invalid

ObjectAlreadyExistsFault - If the user already exists in the role

IllegalArgumentFault - If one of the parameters is invalid

RemoteException

Since:

6.0 (renamed from addUser2 in 6.1)

See Also:

addUser(String, String, String)

removeUserFromProjectRole

void removeUserFromProjectRole(String sessionId,
                               String roleId,
                               String username,
                               String projectOrProjectGroupId)
                        throws RemoteException

Removes a user from a role in the given project

Parameters:

sessionId - User sessionId

roleId - The role id to add the user to

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

projectOrProjectGroupId - projectId (or) Project group ID.

Throws:

InvalidSessionFault - If the session is invalid

PermissionDeniedFault - If the user doesn't have permission to perform the operation

SystemFault - when an unexpected system level error occurs.

NoSuchObjectFault - When the roleId is invalid

IllegalArgumentFault - If one of the parameters is invalid

RemoteException

Since:

6.0 (renamed from removeUser2 in 6.1)

See Also:

removeUser(String, String, String)

addGroup

void addGroup(String sessionId,
              String groupId,
              String roleId,
              String projectOrProjectGroupId)
       throws RemoteException

Adds a user group to a role, within the Project/ProjectGroup scope.

Parameters:

sessionId - User sessionId.

groupId - the user group to be added.

roleId - The role to which the user group is to be added.

projectOrProjectGroupId - The project/projectgroup id to which the role belongs.

Throws:

IllegalArgumentFault - If one of the parameters is invalid.

InvalidSessionFault - If the session is invalid.

PermissionDeniedFault - If the user does not have permission to perform the operation.

SystemFault - When an unexpected system level error occurs.

NoSuchObjectFault - When the roleId is invalid.

ObjectAlreadyExistsFault - If the user group already exists in the role.

RemoteException

Since:

4.4-SP1

removeGroup

void removeGroup(String sessionId,
                 String groupId,
                 String roleId,
                 String projectOrProjectGroupId)
          throws RemoteException

Removes the user group for the role, within the Project/ProjectGroup scope

Parameters:

sessionId - User sessionId.

groupId - the user group to be added.

roleId - The role to which the user group is to be added.

projectOrProjectGroupId - The project/projectgroup id to which the role belongs.

Throws:

IllegalArgumentFault - If one of the parameters is invalid.

InvalidSessionFault - If the session is invalid.

NoSuchObjectFault - When the roleId is invalid.

PermissionDeniedFault - If the user does not have permission to perform the operation.

SystemFault - When an unexpected system level error occurs.

RemoteException

Since:

4.4-SP1

getRoleList

RoleSoapList getRoleList(String sessionId,
                         String projectOrProjectGroupId)
                  throws RemoteException

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

Parameters:

sessionId - User session Id

projectOrProjectGroupId - The Project/Project Group Id to list roles from

Returns:

The RoleSoapList describing all roles in the project

Throws:

InvalidSessionFault - If the session is invalid

PermissionDeniedFault - If the user doesn't have permission to perform the operation

SystemFault - when an unexpected system level error occurs.

NoSuchObjectFault - When the projectId is invalid

ObjectAlreadyExistsFault - If the role exists with the specified title in the project

IllegalArgumentFault - If one of the parameters is invalid

RemoteException

Since:

4.3

getInheritedRoleList

RoleSoapList getInheritedRoleList(String sessionId,
                                  String projectId)
                           throws RemoteException

Gets a list of roles inherited from any of the parent projects. This call requires project admin permission.

Parameters:

sessionId - User session Id

projectId - The project Id to list the inherited roles from

Returns:

The Role2SoapList describing all inherited roles in the project

Throws:

InvalidSessionFault - If the session is invalid

PermissionDeniedFault - If the user doesn't have permission to perform the operation

SystemFault - when an unexpected system level error occurs.

NoSuchObjectFault - When the projectId is invalid

IllegalArgumentFault - If one of the parameters is invalid

RemoteException

Since:

6.0

getRoleMemberList

UserSoapList getRoleMemberList(String sessionId,
                               String roleId)
                        throws RemoteException

Returns a list of users that are assigned to the specified role.

Parameters:

sessionId - User session id.

roleId - Role id.

Returns:

List of users in the specified role.

Throws:

IllegalArgumentFault - Role id is not specified or invalid.

InvalidSessionFault - if the session is invalid.

PermissionDeniedFault - if the user does not have permission to perform the operation

NoSuchObjectFault - when the specified role id is invalid

SystemFault - when an unexpected system level error occurs.

RemoteException

Since:

4.3-SP1

getProjectRoleMemberList

UserSoapList getProjectRoleMemberList(String sessionId,
                                      String roleId,
                                      String projectOrProjectGroupId)
                               throws RemoteException

Returns a list of users that are in a specified role in the given project or project group.

Parameters:

sessionId - User session id.

roleId - Role id.

projectOrProjectGroupId - Project or Project Group Id

Returns:

List of users in the specified role in the given project or project group.

Throws:

IllegalArgumentFault - Role id is not specified or invalid.

InvalidSessionFault - if the session is invalid.

PermissionDeniedFault - if the user does not have permission to perform the operation

NoSuchObjectFault - when the specified role id is invalid

SystemFault - when an unexpected system level error occurs.

RemoteException

Since:

6.0.1 (renamed from getRoleMemberList2 in 6.1)

getUserRoleList

RoleSoapList getUserRoleList(String sessionId,
                             String projectOrProjectGroupId,
                             String username)
                      throws RemoteException

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

Parameters:

sessionId - User session id.

projectOrProjectGroupId - Project or Project Group id.

username - Name of the user.

Returns:

List of roles that a user is a member of.

Throws:

IllegalArgumentFault - Username is not specified or invalid.

InvalidSessionFault - if the session is invalid.

PermissionDeniedFault - if the user does not have permission to perform the operation

NoSuchObjectFault - when the specified project or project group id is invalid

SystemFault - when an unexpected system level error occurs.

RemoteException

Since:

4.3-SP1

getUserSiteWideRoleList

RoleSoapList getUserSiteWideRoleList(String sessionId,
                                     String username)
                              throws RemoteException

Returns a list of roles that a user is a member of site wide role.

Parameters:

sessionId - User session id.

username - Name of the user.

Returns:

List of site-wide roles that a user is a member of.

Throws:

IllegalArgumentFault - Username is not specified or invalid.

InvalidSessionFault - if the session is invalid.

PermissionDeniedFault - if the user does not have permission to perform the operation

NoSuchObjectFault - when the specified project id is invalid

SystemFault - when an unexpected system level error occurs.

RemoteException

Since:

6.0

getSiteWideRoleList

RoleSoapList getSiteWideRoleList(String sessionId)
                          throws RemoteException

Returns a list of all the site-wide roles available on the site.

Parameters:

sessionId - User session id.

Returns:

List of site-wide roles available

Throws:

InvalidSessionFault - if the session is invalid.

PermissionDeniedFault - if the user does not have the permission to perform the operation

SystemFault - when an unexpected system level error occurs.

RemoteException

Since:

6.0

getGlobalRoleList

RoleSoapList getGlobalRoleList(String sessionId)
                        throws RemoteException

Returns a list of all the global roles available on the site.

Parameters:

sessionId - User session id.

Returns:

List of global roles available

Throws:

InvalidSessionFault - if the session is invalid.

PermissionDeniedFault - if the user does not have the permission to perform the operation

SystemFault - when an unexpected system level error occurs.

RemoteException

Since:

6.0

getGlobalRolesForAssignment

RoleSoapList getGlobalRolesForAssignment(String sessionId,
                                         String projectOrProjectGroupId)
                                  throws RemoteException

Returns a list of global roles available in the project or project group for user/user group assignment.

Parameters:

sessionId - User session id.

projectOrProjectGroupId - the project or project group from which to get the global roles list

Returns:

List of global roles available

Throws:

InvalidSessionFault - if the session is invalid.

PermissionDeniedFault - if the user does not have the permission to perform the operation

NoSuchObjectFault - when the specified project or project group id is invalid

SystemFault - when an unexpected system level error occurs.

RemoteException

Since:

6.0

getGroupRoleList

RoleSoapList getGroupRoleList(String sessionId,
                              String groupId,
                              String projectIdOrProjectGroupId)
                       throws RemoteException

Returns a list of roles the user group is associated with in a project or projectGroup.

Parameters:

sessionId - User session id.

groupId - User Group id.

projectIdOrProjectGroupId - Project id or project group id.

Returns:

List of roles the user group is associated with.

Throws:

InvalidSessionFault - if the session is invalid.

PermissionDeniedFault - if the user does not have permission to perform the operation.

SystemFault - when an unexpected system level error occurs.

NoSuchObjectFault - when the specified project id or project group id is invalid.

IllegalArgumentFault - If one of the parameters is invalid.

RemoteException

Since:

4.4-SP1

getRoleGroupList

UserGroupSoapList getRoleGroupList(String sessionId,
                                   String roleId)
                            throws RemoteException

Returns a list of user groups that belong to the specified role.

Parameters:

sessionId - User session id.

roleId - Role id.

Returns:

List of user groups associated with a role.

Throws:

IllegalArgumentFault - roleId is not specified or invalid.

InvalidSessionFault - if the session is invalid.

PermissionDeniedFault - if the user does not have permission to perform the operation.

SystemFault - when an unexpected system level error occurs.

NoSuchObjectFault - when the specified project id is invalid.

RemoteException

Since:

4.4-SP1

listGroupRolesByProject

RoleGroupSoapList listGroupRolesByProject(String sessionId,
                                          String projectId)
                                   throws RemoteException

Returns a list of user groups and the roles it is associated with in a project.

Parameters:

sessionId - User session id.

projectId - Project id.

Returns:

list of user groups and the roles it is associated with

Throws:

IllegalArgumentFault - projectId is not specified or invalid.

InvalidSessionFault - if the session is invalid.

PermissionDeniedFault - if the user does not have permission to perform the operation.

SystemFault - when an unexpected system level error occurs.

NoSuchObjectFault - when the specified project id is invalid.

RemoteException

Since:

4.4-SP1

getRoleGroupUsers

UserSoapList getRoleGroupUsers(String sessionId,
                               String projectIdOrProjectGroupId,
                               String roleId)
                        throws RemoteException

Returns a list of users who are part of a group and associated with the specified role.

Parameters:

sessionId - User session id.

projectIdOrProjectGroupId - Project or Project Group's id.

roleId - Role id.

Returns:

List of users in the specified role.

Throws:

IllegalArgumentFault - Role id is not specified or invalid.

InvalidSessionFault - if the session is invalid.

PermissionDeniedFault - if the user does not have permission to perform the operation

NoSuchObjectFault - when the specified role id is invalid

SystemFault - when an unexpected system level error occurs.

RemoteException

Since:

4.4-SP1

listRolePaths

SoapNamedValues listRolePaths(String sessionId,
                              String roleId,
                              String repositoryId)
                       throws RemoteException

Gets the list of paths for a role.

Parameters:

sessionId - User session Id

roleId - the key of the role the role paths belongs to

repositoryId - the repository id

Returns:

role path in soap named values format

Throws:

InvalidSessionFault - If the session is invalid

PermissionDeniedFault - If the user doesn't have permission to perform the operation

SystemFault - when an unexpected system level error occurs.

NoSuchObjectFault - When the roleId is invalid

IllegalArgumentFault - If one of the parameters is invalid

RemoteException

Since:

5.2

setRolePaths

void setRolePaths(String sessionId,
                  String roleId,
                  String repositoryId,
                  SoapNamedValues rolePaths)
           throws RemoteException

Sets the list of paths for a role.

Parameters:

sessionId - User session Id

roleId - the key of the role the role paths belongs to

repositoryId - the repository id

rolePaths - list of role paths

Throws:

InvalidSessionFault - If the session is invalid

PermissionDeniedFault - If the user doesn't have permission to perform the operation

SystemFault - when an unexpected system level error occurs.

NoSuchObjectFault - When the roleId is invalid

IllegalArgumentFault - If one of the parameters is invalid

RemoteException

Since:

5.2

getProjectsForAction

ProjectSoapList getProjectsForAction(String sessionId,
                                     String operationString,
                                     String userName)
                              throws RemoteException

Gets the list of all projects in which the given user has given permission.

Parameters:

sessionId - User session Id

operationString - Operation in format type.category.name

userName - the user who would have cluster permission in the returned project list

Returns:

List of projects

Throws:

InvalidSessionFault - when the session is invalid

PermissionDeniedFault - when the user doesn't have permission to perform the operation

IllegalArgumentFault - when the arguments are null or empty.

SystemFault - when an unexpected system level error occurs.

NoSuchObjectFault - when the userName doesn't exist.

RemoteException

Since:

6.0

requestRole

void requestRole(String sessionId,
                 String roleId,
                 String projectId)
          throws RemoteException

Requests a role

Parameters:

sessionId - User session Id

roleId - the role id

projectId - project in which to make the request

Throws:

InvalidSessionFault - If the session is invalid

PermissionDeniedFault - If the user doesn't have permission to perform the operation

NoSuchObjectFault - When the roleId or projectId is invalid

IllegalArgumentFault - incorrect parameters

SystemFault - when an unexpected system level error occurs.

RemoteException

Since:

6.0

setAutomaticallyGrantOnRequest

void setAutomaticallyGrantOnRequest(String sessionId,
                                    String roleId,
                                    String projectId,
                                    boolean autoGrant)
                             throws RemoteException

Sets the role's Automatically Grant On Request for the given project.

Parameters:

sessionId - User session Id

roleId - the role id

projectId - the project to which automatically grant property to be set

autoGrant - true to set it available upon request

Throws:

InvalidSessionFault - If the session is invalid

PermissionDeniedFault - If the user doesn't have permission to perform the operation

NoSuchObjectFault - When the projectId is invalid

SystemFault - when an unexpected system level error occurs.

IllegalArgumentFault - when the role is not available upon request

RemoteException

Since:

6.0

getAutomaticallyGrantOnRequest

boolean getAutomaticallyGrantOnRequest(String sessionId,
                                       String roleId,
                                       String projectId)
                                throws RemoteException

Gets the role's Automatically Grant On Request for the given project.

Parameters:

sessionId - User session Id

roleId - the role id

projectId - the project to which automatically grant property to be set

Returns:

Auto grant flag of role

Throws:

InvalidSessionFault - If the session is invalid

PermissionDeniedFault - If the user doesn't have permission to perform the operation

NoSuchObjectFault - When the projectId is invalid

SystemFault - when an unexpected system level error occurs.

IllegalArgumentFault - when there is a request for global role with Projects project id.

RemoteException

Since:

6.0

getPendingRequestedRoles

RoleRequestSoapList getPendingRequestedRoles(String sessionId,
                                             String projectId)
                                      throws RemoteException

Lists the pending requested roles for the given projectId

Parameters:

sessionId - User session Id

projectId - project in which the pending requested roles needs to be retrieved

Returns:

List of pending requested roles.

Throws:

InvalidSessionFault - If the session is invalid

PermissionDeniedFault - If the user doesn't have permission to perform the operation

NoSuchObjectFault - When projectId is invalid

IllegalArgumentFault - incorrect parameters

SystemFault - unexpected error occurs

RemoteException

Since:

6.0

approveRoleRequest

void approveRoleRequest(String sessionId,
                        String requestId,
                        String projectId)
                 throws RemoteException

Approves a role request

Parameters:

sessionId - User session Id

requestId - Role request Id

projectId - project in which the role request was raised

Throws:

InvalidSessionFault - If the session is invalid

PermissionDeniedFault - If the user doesn't have permission to perform the operation

NoSuchObjectFault - When the projectId is invalid

IllegalArgumentFault - incorrect parameters

SystemFault - unexpected error occurs

RemoteException

Since:

6.0

rejectRoleRequest

void rejectRoleRequest(String sessionId,
                       String requestId,
                       String projectId)
                throws RemoteException

Rejects a role request

Parameters:

sessionId - User session Id

requestId - Role request Id

projectId - project in which the role request was raised

Throws:

InvalidSessionFault - If the session is invalid

PermissionDeniedFault - If the user doesn't have permission to perform the operation

NoSuchObjectFault - When the projectId is invalid

IllegalArgumentFault - incorrect parameters

SystemFault - unexpected error occurs

RemoteException

Since:

6.0

listGroupRolesByProjectGroup

RoleGroupSoapList listGroupRolesByProjectGroup(String sessionId,
                                               String projectGroupId)
                                        throws RemoteException

Returns a list of user groups and the roles it is associated with in a project group.

Parameters:

sessionId - User session id.

projectGroupId - Project group id.

Returns:

list of user groups and the roles it is associated with

Throws:

IllegalArgumentFault - projectGroupId is not specified or invalid.

InvalidSessionFault - if the session is invalid.

PermissionDeniedFault - if the user does not have permission to perform the operation.

SystemFault - when an unexpected system level error occurs.

NoSuchObjectFault - when the specified project group id is invalid.

RemoteException

Since:

6.0.1

getProjectsByIntegratedAppPermission

String[] getProjectsByIntegratedAppPermission(String sessionId,
                                              String perm,
                                              String integratedAppName)
                                       throws RemoteException

Returns the list of projects by integratedApp permission.

Parameters:

sessionId - User session key.

perm - permission criteria

integratedAppName - the IntegratedApp plugName.

Returns:

string array of id of projects in which the current user has given permission to given integrated app.

Throws:

InvalidSessionFault - when the specified session id is invalid.

SystemFault - when an unexpected system level error occurs.

NoSuchObjectFault - When the plugName is invalid

IllegalArgumentFault - When the userId is invalid

RemoteException

Since:

5.4

getIntegratedAppPermissionsForProject

String[] getIntegratedAppPermissionsForProject(String sessionId,
                                               String projectId,
                                               String linkId)
                                        throws RemoteException

Returns integratedApp permissions for the user associated with a project

Parameters:

sessionId - User session key.

projectId - the projectId

linkId - the linkId between integrated app and project

Returns:

String array of permissions for given integrated application

Throws:

InvalidSessionFault - when the specified session id is invalid.

NoSuchObjectFault

RemoteException

Since:

5.4

getIntegratedAppPermissions

IntegratedAppProjectPermissionSoapList getIntegratedAppPermissions(String sessionId,
                                                                   String[] projectIds,
                                                                   String baseUrl)
                                                            throws RemoteException

Returns list of integratedApp permissions for the user associated with specified projects

Parameters:

sessionId - User session key.

projectIds - the projectIds

baseUrl - the base url of the integrated application

Returns:

List of integrated application permission on the specified projects for current user

Throws:

IllegalArgumentFault - when baseUrl is null or empty

InvalidSessionFault - when the specified session id is invalid.

NoSuchObjectFault - when the specified baseUrl is invalid

SystemFault - when an unexpected system error occurs

RemoteException

Since:

18.2