Interface UserIdentityManagementInterface

  • All Known Implementing Classes:
    UserIdentityManagement

    public interface UserIdentityManagementInterface
    UserIdentityManagementInterface provides administrative function to alter the association between a profile (either personal profile or IT profile) and a user identity. Typically a corresponding user identity is automatically created with each profile. If a user, or an engine, has multiple userIds that should be associated with the same profile, then the manual management of user identities is required.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void addIdentityToProfile​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String userIdentityGUID, java.lang.String profileGUID, ProfileIdentityProperties properties)
      Link a user identity to a profile.
      java.lang.String createUserIdentity​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, UserIdentityProperties newIdentity)
      Create a UserIdentity.
      java.lang.String createUserIdentityForProfile​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String profileGUID, UserIdentityProperties newIdentity)
      Create a UserIdentity that is for the sole use of a specific actor profile.
      void deleteUserIdentity​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String userIdentityGUID)
      Remove a user identity object.
      java.util.List<UserIdentityElement> findUserIdentities​(java.lang.String userId, java.lang.String searchString, int startFrom, int pageSize)
      Retrieve the list of user identity metadata elements that contain the search string.
      java.util.List<UserIdentityElement> getUserIdentitiesByName​(java.lang.String userId, java.lang.String name, int startFrom, int pageSize)
      Retrieve the list of user identity metadata elements with a matching qualified name.
      UserIdentityElement getUserIdentityByGUID​(java.lang.String userId, java.lang.String userIdentityGUID)
      Retrieve the userIdentity metadata element with the supplied unique identifier.
      void removeIdentityFromProfile​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String userIdentityGUID, java.lang.String profileGUID)
      Unlink a user identity from a profile.
      void updateProfileIdentity​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String userIdentityGUID, java.lang.String profileGUID, boolean isMergeUpdate, ProfileIdentityProperties properties)
      Update the properties of the relationship between a user identity and profile.
      void updateUserIdentity​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String userIdentityGUID, boolean isMergeUpdate, UserIdentityProperties properties)
      Update a UserIdentity.
    • Method Detail

      • createUserIdentity

        java.lang.String createUserIdentity​(java.lang.String userId,
                                            java.lang.String externalSourceGUID,
                                            java.lang.String externalSourceName,
                                            UserIdentityProperties newIdentity)
                                     throws InvalidParameterException,
                                            PropertyServerException,
                                            UserNotAuthorizedException
        Create a UserIdentity. This is not connected to a profile.
        Parameters:
        userId - the name of the calling user.
        externalSourceGUID - unique identifier of software server capability representing the caller
        externalSourceName - unique name of software server capability representing the caller
        newIdentity - properties for the new userIdentity
        Returns:
        unique identifier of the UserIdentity
        Throws:
        InvalidParameterException - one of the parameters is invalid.
        PropertyServerException - there is a problem retrieving information from the property server(s).
        UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      • createUserIdentityForProfile

        java.lang.String createUserIdentityForProfile​(java.lang.String userId,
                                                      java.lang.String externalSourceGUID,
                                                      java.lang.String externalSourceName,
                                                      java.lang.String profileGUID,
                                                      UserIdentityProperties newIdentity)
                                               throws InvalidParameterException,
                                                      PropertyServerException,
                                                      UserNotAuthorizedException
        Create a UserIdentity that is for the sole use of a specific actor profile.
        Parameters:
        userId - the name of the calling user.
        externalSourceGUID - unique identifier of software server capability representing the caller
        externalSourceName - unique name of software server capability representing the caller
        profileGUID - unique identifier of the profile
        newIdentity - properties for the new userIdentity
        Returns:
        unique identifier of the UserIdentity
        Throws:
        InvalidParameterException - one of the parameters is invalid.
        PropertyServerException - there is a problem retrieving information from the property server(s).
        UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      • updateUserIdentity

        void updateUserIdentity​(java.lang.String userId,
                                java.lang.String externalSourceGUID,
                                java.lang.String externalSourceName,
                                java.lang.String userIdentityGUID,
                                boolean isMergeUpdate,
                                UserIdentityProperties properties)
                         throws InvalidParameterException,
                                PropertyServerException,
                                UserNotAuthorizedException
        Update a UserIdentity.
        Parameters:
        userId - the name of the calling user
        externalSourceGUID - unique identifier of software server capability representing the caller
        externalSourceName - unique name of software server capability representing the caller
        userIdentityGUID - unique identifier of the UserIdentity
        isMergeUpdate - should the supplied properties be overlaid on the existing properties (true) or replace them (false
        properties - updated properties for the new userIdentity
        Throws:
        InvalidParameterException - one of the parameters is invalid.
        PropertyServerException - there is a problem retrieving information from the property server(s).
        UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      • deleteUserIdentity

        void deleteUserIdentity​(java.lang.String userId,
                                java.lang.String externalSourceGUID,
                                java.lang.String externalSourceName,
                                java.lang.String userIdentityGUID)
                         throws InvalidParameterException,
                                PropertyServerException,
                                UserNotAuthorizedException
        Remove a user identity object.
        Parameters:
        userId - the name of the calling user
        externalSourceGUID - unique identifier of software server capability representing the caller
        externalSourceName - unique name of software server capability representing the caller
        userIdentityGUID - unique identifier of the UserIdentity
        Throws:
        InvalidParameterException - one of the parameters is invalid.
        PropertyServerException - there is a problem retrieving information from the property server(s).
        UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      • addIdentityToProfile

        void addIdentityToProfile​(java.lang.String userId,
                                  java.lang.String externalSourceGUID,
                                  java.lang.String externalSourceName,
                                  java.lang.String userIdentityGUID,
                                  java.lang.String profileGUID,
                                  ProfileIdentityProperties properties)
                           throws InvalidParameterException,
                                  PropertyServerException,
                                  UserNotAuthorizedException
        Link a user identity to a profile.
        Parameters:
        userId - the name of the calling user
        externalSourceGUID - unique identifier of software server capability representing the caller
        externalSourceName - unique name of software server capability representing the caller
        userIdentityGUID - additional userId for the profile
        profileGUID - the profile to add the identity to
        properties - the properties that describe how the owner of the profile uses the user identity
        Throws:
        InvalidParameterException - one of the parameters is invalid.
        PropertyServerException - there is a problem retrieving information from the property server(s).
        UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      • updateProfileIdentity

        void updateProfileIdentity​(java.lang.String userId,
                                   java.lang.String externalSourceGUID,
                                   java.lang.String externalSourceName,
                                   java.lang.String userIdentityGUID,
                                   java.lang.String profileGUID,
                                   boolean isMergeUpdate,
                                   ProfileIdentityProperties properties)
                            throws InvalidParameterException,
                                   PropertyServerException,
                                   UserNotAuthorizedException
        Update the properties of the relationship between a user identity and profile.
        Parameters:
        userId - the name of the calling user
        externalSourceGUID - unique identifier of software server capability representing the caller
        externalSourceName - unique name of software server capability representing the caller
        userIdentityGUID - additional userId for the profile
        profileGUID - the profile to add the identity to
        isMergeUpdate - should the supplied properties be overlaid on the existing properties (true) or replace them (false
        properties - the properties that describe how the owner of the profile uses the user identity
        Throws:
        InvalidParameterException - one of the parameters is invalid.
        PropertyServerException - there is a problem retrieving information from the property server(s).
        UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      • removeIdentityFromProfile

        void removeIdentityFromProfile​(java.lang.String userId,
                                       java.lang.String externalSourceGUID,
                                       java.lang.String externalSourceName,
                                       java.lang.String userIdentityGUID,
                                       java.lang.String profileGUID)
                                throws InvalidParameterException,
                                       PropertyServerException,
                                       UserNotAuthorizedException
        Unlink a user identity from a profile.
        Parameters:
        userId - the name of the calling user.
        externalSourceGUID - unique identifier of software server capability representing the caller
        externalSourceName - unique name of software server capability representing the caller
        userIdentityGUID - unique identifier of the UserIdentity
        profileGUID - the profile to add the identity to.
        Throws:
        InvalidParameterException - one of the parameters is invalid.
        PropertyServerException - there is a problem retrieving information from the property server(s).
        UserNotAuthorizedException - the requesting user is not authorized to issue this request.