Package org.openiam.srvc.idm
Interface ProvisionService
-
- All Known Implementing Classes:
DefaultProvisioningService
public interface ProvisionService
ProvisionService
Interface 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 Response
addEvent(ProvisionActionEvent event, ProvisionActionTypeEnum type)
ManagedSystemViewerResponse
buildManagedSystemViewer(String userId, String managedSysId)
Response
deleteUser(DeleteUserProvisioningRequest request)
Deletes a user from OpenIAM and appropriate target systemsResponse
deProvisionUsersToResource(List<String> userIds, List<String> resourceIds)
Response
disableUser(DisableUserProvisioningRequest request)
Operation to disable user account based on request dataResponse
enableUser(EnableUserProvisioningRequest request)
Operation to enable user account based on request dataList<String>
getAttributeNamesFromConnector(String managedSysId, boolean attributes)
Response
lockUser(LockUserProvisionRequest request)
Operation locks accountResponse
provisionUsersToResource(List<String> userIds, List<String> resourceIds)
Response
requestAdd(ExtensibleUser extUser, Login login)
Adds user directly to a given target system bypassing policy map attributes script logicResponse
requestModify(ExtensibleUser extUser, Login login)
Modifies user directly in a given target system bypassing policy map attributes script logicUserPasswordResponse
resetPassword(PasswordSync passwordSync)
Reset password in target systemsResponse
retryConnectorRequest(String replyId)
Response
retryProvisionRequest(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 failedResponse
saveUser(ProvisionUser user)
The saveUser operation enables a requester to create or update a new user on the target systems.LookupUserResponse
searchUser(SearchObjectsProvisioningRequest request)
Operation unlocks an accountPasswordValidationResponse
setPassword(PasswordSync passwordSync)
The setPassword operation enables a requestor to specify a new password for an user across target systemsResponse
startBulkOperation(BulkOperationRequest bulkRequest, boolean async)
Response
syncPasswordFromSrc(PasswordSync passwordSync)
Method is used by target systems to inform OpenIAM that password was changed.Response
testConnectionConfig(String managedSysId)
Operation validates the connection information that was supplied for this managed systemResponse
unlockUser(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.managedSystemId
zaporozhets- Parameters:
passwordSync
- - synchronization password requests- Returns:
- Response with
Response.status
=ResponseStatus.SUCCESS
in case that operation performed correctly,method returnResponse.status
=ResponseStatus.FAILURE
in case of error. You can check error code inResponse.errorCode
andResponse.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)
-
-