Interface IRbacAppSoap
-
- All Known Implementing Classes:
RbacAppSoap,RbacAppSoapMockStub,RbacAppSoapStub
public interface IRbacAppSoap
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidaddCluster(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.voidaddGroup(String sessionId, String groupId, String roleId, String projectOrProjectGroupId)Adds a user group to a role, within the Project/ProjectGroup scope.voidaddIntegratedApplicationPermission(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.voidaddUser(String sessionId, String roleId, String username)Adds a user to the role, giving them all of the permissions of that rolevoidaddUserToProjectRole(String sessionId, String roleId, String username, String projectOrProjectGroupId)Adds a user to the role in the given project contextvoidapproveRoleRequest(String sessionId, String requestId, String projectId)Approves a role requestRoleSoapDOcreateGlobalRole(String sessionId, String title, String description, boolean preventInheritance, boolean requestable)Creates a global role.RoleSoapDOcreateRole(String sessionId, String projectOrProjectGroupId, String title, String description, boolean preventInheritance, boolean requestable, boolean autoGrant)Creates a role in a given projectRoleSoapDOcreateSiteWideRole(String sessionId, String title, String description, boolean preventInheritance)Creates a site-wide role.voiddeleteRole(String sessionId, String roleId)Deletes a role.booleangetAutomaticallyGrantOnRequest(String sessionId, String roleId, String projectId)Gets the role's Automatically Grant On Request for the given project.RoleSoapListgetGlobalRoleList(String sessionId)Returns a list of all the global roles available on the site.RoleSoapListgetGlobalRolesForAssignment(String sessionId, String projectOrProjectGroupId)Returns a list of global roles available in the project or project group for user/user group assignment.RoleSoapListgetGroupRoleList(String sessionId, String groupId, String projectIdOrProjectGroupId)Returns a list of roles the user group is associated with in a project or projectGroup.RoleSoapListgetInheritedRoleList(String sessionId, String projectId)Gets a list of roles inherited from any of the parent projects.IntegratedAppProjectPermissionSoapListgetIntegratedAppPermissions(String sessionId, String[] projectIds, String baseUrl)Returns list of integratedApp permissions for the user associated with specified projectsString[]getIntegratedAppPermissionsForProject(String sessionId, String projectId, String linkId)Returns integratedApp permissions for the user associated with a projectRoleRequestSoapListgetPendingRequestedRoles(String sessionId, String projectId)Lists the pending requested roles for the given projectIdUserSoapListgetProjectRoleMemberList(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.ProjectSoapListgetProjectsForAction(String sessionId, String operationString, String userName)Gets the list of all projects in which the given user has given permission.RoleSoapDOgetRoleData(String sessionId, String roleId)Get a role data.UserGroupSoapListgetRoleGroupList(String sessionId, String roleId)Returns a list of user groups that belong to the specified role.UserSoapListgetRoleGroupUsers(String sessionId, String projectIdOrProjectGroupId, String roleId)Returns a list of users who are part of a group and associated with the specified role.RoleSoapListgetRoleList(String sessionId, String projectOrProjectGroupId)Gets a list of Roles in a project context.UserSoapListgetRoleMemberList(String sessionId, String roleId)Returns a list of users that are assigned to the specified role.RoleSoapListgetSiteWideRoleList(String sessionId)Returns a list of all the site-wide roles available on the site.RoleSoapListgetUserRoleList(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.RoleSoapListgetUserSiteWideRoleList(String sessionId, String username)Returns a list of roles that a user is a member of site wide role.voidgrantRolesToMembers(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.RoleCluster2SoapListlistClusterForDefaultAccessPermissions(String sessionId, String projectId)Gets the list of operation cluster with default access permission.RoleClusterSoapListlistClusters(String sessionId, String roleId)Gets the list of operation cluster assigned to a role.RoleGroupSoapListlistGroupRolesByProject(String sessionId, String projectId)Returns a list of user groups and the roles it is associated with in a project.RoleGroupSoapListlistGroupRolesByProjectGroup(String sessionId, String projectGroupId)Returns a list of user groups and the roles it is associated with in a project group.SoapNamedValueslistRolePaths(String sessionId, String roleId, String repositoryId)Gets the list of paths for a role.voidrejectRoleRequest(String sessionId, String requestId, String projectId)Rejects a role requestvoidremoveCluster(String sessionId, String roleId, String operationCluster, String folderId)Removes an operation cluster to a role, removing the permission set.voidremoveGroup(String sessionId, String groupId, String roleId, String projectOrProjectGroupId)Removes the user group for the role, within the Project/ProjectGroup scopevoidremoveIntegratedApplicationPermission(String sessionId, String roleId, String integratedAppName, String permission)Removes an integrated application permission from the given role.voidremoveUser(String sessionId, String roleId, String username)Removes a user from a rolevoidremoveUserFromProjectRole(String sessionId, String roleId, String username, String projectOrProjectGroupId)Removes a user from a role in the given projectvoidrequestRole(String sessionId, String roleId, String projectId)Requests a rolevoidrevokeRolesFromMembers(String sessionId, UserRolesSoapDO[] userRolesSoapDOs, String projectId)Removes roles from users in the projectvoidsetAutomaticallyGrantOnRequest(String sessionId, String roleId, String projectId, boolean autoGrant)Sets the role's Automatically Grant On Request for the given project.voidsetRoleData(String sessionId, RoleSoapDO roleData)Saves a role object.voidsetRolePaths(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 IdprojectOrProjectGroupId- The project /project group Id to create the role intitle- The title of the roledescription- A description of the rolepreventInheritance- If the role's permission is prevented from applying to private subprojects.requestable- If the role is available upon requestautoGrant- If the role is granted automatically on request- Returns:
- The Role2SoapDO that was created
- Throws:
InvalidSessionFault- If the session is invalidPermissionDeniedFault- If the user doesn't have permission to perform the operationSystemFault- 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 projectIllegalArgumentFault- If one of the parameters is invalidRemoteException- 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 Idtitle- The title of the site-wide roledescription- A description of the rolepreventInheritance- If the role's permission is prevented from applying to private projects.- Returns:
- The Role2SoapDO that was created
- Throws:
InvalidSessionFault- If the session is invalidPermissionDeniedFault- If the user doesn't have permission to perform the operationSystemFault- when an unexpected system level error occurs.NoSuchObjectFault- When the created roleId is invalidObjectAlreadyExistsFault- If the role exists with the specified title in the projectIllegalArgumentFault- If one of the parameters is invalidRemoteException- 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 Idtitle- The title of the global roledescription- The description of the global rolepreventInheritance- 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 invalidPermissionDeniedFault- If the user doesn't have permission to perform the operationSystemFault- when an unexpected system level error occurs.NoSuchObjectFault- When the created roleId is invalidObjectAlreadyExistsFault- If the global role exists with the specified titleIllegalArgumentFault- If one of the parameters is invalidRemoteException- Since:
- 6.0
-
setRoleData
void setRoleData(String sessionId, RoleSoapDO roleData) throws RemoteException
Saves a role object.- Parameters:
sessionId- User session IdroleData- the role object to save- Throws:
InvalidSessionFault- If the session is invalidVersionMismatchFault- The role version being edited is not the latest onePermissionDeniedFault- If the user doesn't have permission to perform the operationIllegalArgumentFault- If one of the parameters is invalidNoSuchObjectFault- When the roleId is invalidSystemFault- 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 IdroleId- The id of the role to be fetch- Returns:
- The RoleSoapDO that was fetched
- Throws:
InvalidSessionFault- If the session is invalidPermissionDeniedFault- If the user doesn't have permission to perform the operationNoSuchObjectFault- When the roleId is invalidSystemFault- when an unexpected system level error occurs.IllegalArgumentFault- When the roleId is invalidRemoteException- Since:
- 8.0
-
deleteRole
void deleteRole(String sessionId, String roleId) throws RemoteException
Deletes a role.- Parameters:
sessionId- User session IdroleId- The id of the role to be deleted- Throws:
InvalidSessionFault- If the session is invalidPermissionDeniedFault- If the user doesn't have permission to perform the operationSystemFault- when an unexpected system level error occurs.NoSuchObjectFault- When the projectId is invalidRemoteException- 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 IdroleId- The role id to add the cluster tooperationCluster- The cluster name to add to the role. See OperationClusterConstants.folderId- the folder id for the specified cluster.- Throws:
InvalidSessionFault- If the session is invalidPermissionDeniedFault- If the user doesn't have permission to perform the operationSystemFault- when an unexpected system level error occurs.NoSuchObjectFault- When the roleId is invalidObjectAlreadyExistsFault- If the cluster already exists in the roleIllegalArgumentFault- If one of the parameters is invalidRemoteException- 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 IdroleId- The role id to add the integrated application permission tointegratedAppName- 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 invalidPermissionDeniedFault- If the user doesn't have permission to perform the operationSystemFault- when an unexpected system level error occurs.NoSuchObjectFault- When the roleId is invalidObjectAlreadyExistsFault- If the cluster already exists in the roleIllegalArgumentFault- If one of the parameters is invalidRemoteException- 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 IdroleId- The role id from which the integrated application permission to be removedintegratedAppName- 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 invalidPermissionDeniedFault- If the user doesn't have permission to perform the operationSystemFault- when an unexpected system level error occurs.NoSuchObjectFault- When the roleId is invalidObjectAlreadyExistsFault- If the cluster already exists in the roleIllegalArgumentFault- If one of the parameters is invalidRemoteException- 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 IdroleId- The role id to remove the cluster tooperationCluster- The cluster name to add to the rolefolderId- the folder id for the specified cluster.- Throws:
InvalidSessionFault- If the session is invalidIllegalArgumentFault- If one of the parameters is invalidPermissionDeniedFault- If the user doesn't have permission to perform the operationSystemFault- when an unexpected system level error occurs.NoSuchObjectFault- When the roleId is invalidRemoteException- 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 IdroleId- The ID of the role for which clusters will be listed- Returns:
- list of clusters for a role
- Throws:
InvalidSessionFault- If the session is invalidIllegalArgumentFault- If one of the parameters is invalidPermissionDeniedFault- If the user doesn't have permission to perform the operationSystemFault- when an unexpected system level error occurs.NoSuchObjectFault- When the roleId is invalidRemoteException- 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 IdprojectId- The ID of the project for which clusters will be listed- Returns:
- list of clusters for a project
- Throws:
InvalidSessionFault- If the session is invalidIllegalArgumentFault- If one of the parameters is invalidNoSuchObjectFault- When the roleId is invalidSystemFaultPermissionDeniedFaultRemoteException- 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 sessionIdroleId- The role id to add the user tousername- The username of the user to add to the role- Throws:
InvalidSessionFault- If the session is invalidPermissionDeniedFault- If the user doesn't have permission to perform the operationSystemFault- when an unexpected system level error occurs.NoSuchObjectFault- When the roleId is invalidObjectAlreadyExistsFault- If the user already exists in the roleIllegalArgumentFault- If one of the parameters is invalidRemoteException- 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 sessionIduserRolesSoapDOs- user to roles data containerprojectId- project to which users would be the members with the given roles.- Throws:
InvalidSessionFault- If the session is invalidPermissionDeniedFault- If the user doesn't have permission to perform the operationSystemFault- when an unexpected system level error occurs.NoSuchObjectFault- When the roleId is invalidObjectAlreadyExistsFault- If the user already exists in the roleIllegalArgumentFault- If one of the parameters is invalidRemoteException- Since:
- 6.0
-
removeUser
void removeUser(String sessionId, String roleId, String username) throws RemoteException
Removes a user from a role- Parameters:
sessionId- User sessionIdroleId- The role id to add the user tousername- The username of the user to add to the role- Throws:
InvalidSessionFault- If the session is invalidPermissionDeniedFault- If the user doesn't have permission to perform the operationSystemFault- when an unexpected system level error occurs.NoSuchObjectFault- When the roleId is invalidIllegalArgumentFault- If one of the parameters is invalidRemoteException- 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 sessionIduserRolesSoapDOs- user to roles data containerprojectId- project in which roles would be removed from the users.- Throws:
InvalidSessionFault- If the session is invalidPermissionDeniedFault- If the user doesn't have permission to perform the operationSystemFault- when an unexpected system level error occurs.NoSuchObjectFault- When the roleId is invalidIllegalArgumentFault- If one of the parameters is invalidRemoteException- 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 sessionIdroleId- The role id to add the user tousername- The username of the user to add to the roleprojectOrProjectGroupId- projectId (or) Project group ID.- Throws:
InvalidSessionFault- If the session is invalidPermissionDeniedFault- If the user doesn't have permission to perform the operationSystemFault- when an unexpected system level error occurs.NoSuchObjectFault- When the roleId is invalidObjectAlreadyExistsFault- If the user already exists in the roleIllegalArgumentFault- If one of the parameters is invalidRemoteException- 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 sessionIdroleId- The role id to add the user tousername- The username of the user to add to the roleprojectOrProjectGroupId- projectId (or) Project group ID.- Throws:
InvalidSessionFault- If the session is invalidPermissionDeniedFault- If the user doesn't have permission to perform the operationSystemFault- when an unexpected system level error occurs.NoSuchObjectFault- When the roleId is invalidIllegalArgumentFault- If one of the parameters is invalidRemoteException- 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 IdprojectOrProjectGroupId- The Project/Project Group Id to list roles from- Returns:
- The RoleSoapList describing all roles in the project
- Throws:
InvalidSessionFault- If the session is invalidPermissionDeniedFault- If the user doesn't have permission to perform the operationSystemFault- when an unexpected system level error occurs.NoSuchObjectFault- When the projectId is invalidObjectAlreadyExistsFault- If the role exists with the specified title in the projectIllegalArgumentFault- If one of the parameters is invalidRemoteException- 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 IdprojectId- 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 invalidPermissionDeniedFault- If the user doesn't have permission to perform the operationSystemFault- when an unexpected system level error occurs.NoSuchObjectFault- When the projectId is invalidIllegalArgumentFault- If one of the parameters is invalidRemoteException- 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 operationNoSuchObjectFault- when the specified role id is invalidSystemFault- 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 operationNoSuchObjectFault- when the specified role id is invalidSystemFault- 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 operationNoSuchObjectFault- when the specified project or project group id is invalidSystemFault- 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 operationNoSuchObjectFault- when the specified project id is invalidSystemFault- 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 operationSystemFault- 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 operationSystemFault- 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 operationNoSuchObjectFault- when the specified project or project group id is invalidSystemFault- 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 operationNoSuchObjectFault- when the specified role id is invalidSystemFault- 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 IdroleId- the key of the role the role paths belongs torepositoryId- the repository id- Returns:
- role path in soap named values format
- Throws:
InvalidSessionFault- If the session is invalidPermissionDeniedFault- If the user doesn't have permission to perform the operationSystemFault- when an unexpected system level error occurs.NoSuchObjectFault- When the roleId is invalidIllegalArgumentFault- If one of the parameters is invalidRemoteException- 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 IdroleId- the key of the role the role paths belongs torepositoryId- the repository idrolePaths- list of role paths- Throws:
InvalidSessionFault- If the session is invalidPermissionDeniedFault- If the user doesn't have permission to perform the operationSystemFault- when an unexpected system level error occurs.NoSuchObjectFault- When the roleId is invalidIllegalArgumentFault- If one of the parameters is invalidRemoteException- 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 IdoperationString- Operation in format type.category.nameuserName- the user who would have cluster permission in the returned project list- Returns:
- List of projects
- Throws:
InvalidSessionFault- when the session is invalidPermissionDeniedFault- when the user doesn't have permission to perform the operationIllegalArgumentFault- 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 IdroleId- the role idprojectId- project in which to make the request- Throws:
InvalidSessionFault- If the session is invalidPermissionDeniedFault- If the user doesn't have permission to perform the operationNoSuchObjectFault- When the roleId or projectId is invalidIllegalArgumentFault- incorrect parametersSystemFault- 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 IdroleId- the role idprojectId- the project to which automatically grant property to be setautoGrant- true to set it available upon request- Throws:
InvalidSessionFault- If the session is invalidPermissionDeniedFault- If the user doesn't have permission to perform the operationNoSuchObjectFault- When the projectId is invalidSystemFault- when an unexpected system level error occurs.IllegalArgumentFault- when the role is not available upon requestRemoteException- 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 IdroleId- the role idprojectId- the project to which automatically grant property to be set- Returns:
- Auto grant flag of role
- Throws:
InvalidSessionFault- If the session is invalidPermissionDeniedFault- If the user doesn't have permission to perform the operationNoSuchObjectFault- When the projectId is invalidSystemFault- 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 IdprojectId- project in which the pending requested roles needs to be retrieved- Returns:
- List of pending requested roles.
- Throws:
InvalidSessionFault- If the session is invalidPermissionDeniedFault- If the user doesn't have permission to perform the operationNoSuchObjectFault- When projectId is invalidIllegalArgumentFault- incorrect parametersSystemFault- unexpected error occursRemoteException- Since:
- 6.0
-
approveRoleRequest
void approveRoleRequest(String sessionId, String requestId, String projectId) throws RemoteException
Approves a role request- Parameters:
sessionId- User session IdrequestId- Role request IdprojectId- project in which the role request was raised- Throws:
InvalidSessionFault- If the session is invalidPermissionDeniedFault- If the user doesn't have permission to perform the operationNoSuchObjectFault- When the projectId is invalidIllegalArgumentFault- incorrect parametersSystemFault- unexpected error occursRemoteException- Since:
- 6.0
-
rejectRoleRequest
void rejectRoleRequest(String sessionId, String requestId, String projectId) throws RemoteException
Rejects a role request- Parameters:
sessionId- User session IdrequestId- Role request IdprojectId- project in which the role request was raised- Throws:
InvalidSessionFault- If the session is invalidPermissionDeniedFault- If the user doesn't have permission to perform the operationNoSuchObjectFault- When the projectId is invalidIllegalArgumentFault- incorrect parametersSystemFault- unexpected error occursRemoteException- 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 criteriaintegratedAppName- 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 invalidIllegalArgumentFault- When the userId is invalidRemoteException- 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 projectIdlinkId- 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.NoSuchObjectFaultRemoteException- 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 projectIdsbaseUrl- 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 emptyInvalidSessionFault- when the specified session id is invalid.NoSuchObjectFault- when the specified baseUrl is invalidSystemFault- when an unexpected system error occursRemoteException- Since:
- 18.2
-
-