Package org.openiam.srvc.idm
Interface ProvisionService
-
- All Known Implementing Classes:
DefaultProvisioningService
public interface ProvisionServiceProvisionServiceInterface for the Provisioning service which is used for provisioning users.- Author:
- suneet
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ResponseaddEvent(ProvisionActionEvent event, ProvisionActionTypeEnum type)ManagedSystemViewerResponsebuildManagedSystemViewer(String userId, String managedSysId)ResponsedeleteUser(DeleteUserProvisioningRequest request)Deletes a user from OpenIAM and appropriate target systemsResponsedeProvisionUsersToResource(List<String> userIds, List<String> resourceIds)ResponsedisableUser(DisableUserProvisioningRequest request)Operation to disable user account based on request dataResponseenableUser(EnableUserProvisioningRequest request)Operation to enable user account based on request dataList<String>getAttributeNamesFromConnector(String managedSysId, boolean attributes)ResponselockUser(LockUserProvisionRequest request)Operation locks accountResponseprovisionUsersToResource(List<String> userIds, List<String> resourceIds)ResponserequestAdd(ExtensibleUser extUser, Login login)Adds user directly to a given target system bypassing policy map attributes script logicResponserequestModify(ExtensibleUser extUser, Login login)Modifies user directly in a given target system bypassing policy map attributes script logicUserPasswordResponseresetPassword(PasswordSync passwordSync)Reset password in target systemsResponseretryConnectorRequest(String replyId)ResponseretryProvisionRequest(String provisionRequestId)method used to re-send failed provision request to connector again, important, it does't generate new diff object, it just re-sends what was sent but failedResponsesaveUser(ProvisionUser user)The saveUser operation enables a requester to create or update a new user on the target systems.LookupUserResponsesearchUser(SearchObjectsProvisioningRequest request)Operation unlocks an accountPasswordValidationResponsesetPassword(PasswordSync passwordSync)The setPassword operation enables a requestor to specify a new password for an user across target systemsResponsestartBulkOperation(BulkOperationRequest bulkRequest, boolean async)ResponsesyncPasswordFromSrc(PasswordSync passwordSync)Method is used by target systems to inform OpenIAM that password was changed.ResponsetestConnectionConfig(String managedSysId)Operation validates the connection information that was supplied for this managed systemResponseunlockUser(UnlockUserProvisionRequest request)Operation unlocks an account
-
-
-
Method Detail
-
testConnectionConfig
Response testConnectionConfig(String managedSysId)
Operation validates the connection information that was supplied for this managed system- Parameters:
managedSysId-- Returns:
-
saveUser
Response saveUser(ProvisionUser user)
The saveUser operation enables a requester to create or update a new user on the target systems. Also this operation can do modify if this user has existed in one of the target systems.- Parameters:
user- - new provisioning user- Returns:
- ProvisionUserResponse
- Throws:
Exception
-
deleteUser
Response deleteUser(DeleteUserProvisioningRequest request)
Deletes a user from OpenIAM and appropriate target systems- Parameters:
request-- Returns:
-
getAttributeNamesFromConnector
List<String> getAttributeNamesFromConnector(String managedSysId, boolean attributes)
-
setPassword
PasswordValidationResponse setPassword(PasswordSync passwordSync)
The setPassword operation enables a requestor to specify a new password for an user across target systems- Parameters:
passwordSync-- Returns:
-
syncPasswordFromSrc
Response syncPasswordFromSrc(PasswordSync passwordSync)
Method is used by target systems to inform OpenIAM that password was changed. OpenIAM will update password value for all identities that user has and perform provisioning to all target systems except target system that pointed inPasswordSync.managedSystemIdzaporozhets- Parameters:
passwordSync- - synchronization password requests- Returns:
- Response with
Response.status=ResponseStatus.SUCCESSin case that operation performed correctly,method returnResponse.status=ResponseStatus.FAILUREin case of error. You can check error code inResponse.errorCodeandResponse.errorText
-
resetPassword
UserPasswordResponse resetPassword(PasswordSync passwordSync)
Reset password in target systems- Parameters:
passwordSync-- Returns:
- PasswordResponse
-
lockUser
Response lockUser(LockUserProvisionRequest request)
Operation locks account- Parameters:
request-- Returns:
-
unlockUser
Response unlockUser(UnlockUserProvisionRequest request)
Operation unlocks an account- Parameters:
request-- Returns:
-
searchUser
LookupUserResponse searchUser(SearchObjectsProvisioningRequest request)
Operation unlocks an account- Parameters:
request-- Returns:
-
disableUser
Response disableUser(DisableUserProvisioningRequest request)
Operation to disable user account based on request data- Parameters:
request-- Returns:
-
enableUser
Response enableUser(EnableUserProvisioningRequest request)
Operation to enable user account based on request data- Parameters:
request-- Returns:
-
startBulkOperation
Response startBulkOperation(BulkOperationRequest bulkRequest, boolean async)
-
buildManagedSystemViewer
ManagedSystemViewerResponse buildManagedSystemViewer(String userId, String managedSysId)
-
requestAdd
Response requestAdd(ExtensibleUser extUser, Login login)
Adds user directly to a given target system bypassing policy map attributes script logic- Parameters:
extUser-login-- Returns:
-
requestModify
Response requestModify(ExtensibleUser extUser, Login login)
Modifies user directly in a given target system bypassing policy map attributes script logic- Parameters:
extUser-login-- Returns:
-
addEvent
Response addEvent(ProvisionActionEvent event, ProvisionActionTypeEnum type)
-
deProvisionUsersToResource
Response deProvisionUsersToResource(List<String> userIds, List<String> resourceIds)
-
provisionUsersToResource
Response provisionUsersToResource(List<String> userIds, List<String> resourceIds)
-
-