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 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
      • 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 in PasswordSync.managedSystemId zaporozhets
        Parameters:
        passwordSync - - synchronization password requests
        Returns:
        Response with Response.status = ResponseStatus.SUCCESS in case that operation performed correctly,method return Response.status = ResponseStatus.FAILURE in case of error. You can check error code in Response.errorCode and Response.errorText
      • resetPassword

        UserPasswordResponse resetPassword​(PasswordSync passwordSync)
        Reset password in target systems
        Parameters:
        passwordSync -
        Returns:
        PasswordResponse
      • 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:
      • retryConnectorRequest

        Response retryConnectorRequest​(String replyId)
      • retryProvisionRequest

        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 failed
        Parameters:
        provisionRequestId -
        Returns: