Package org.odpi.openmetadata.accessservices.communityprofile.api

Interface UserIdentityManagementInterface

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

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

  • Method Details

    • createUserIdentity

      String createUserIdentity(String userId, String externalSourceGUID, String externalSourceName, org.odpi.openmetadata.frameworks.openmetadata.properties.actors.UserIdentityProperties newIdentity) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • createUserIdentityForProfile

      String createUserIdentityForProfile(String userId, String externalSourceGUID, String externalSourceName, String profileGUID, org.odpi.openmetadata.frameworks.openmetadata.properties.actors.UserIdentityProperties newIdentity) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • updateUserIdentity

      void updateUserIdentity(String userId, String externalSourceGUID, String externalSourceName, String userIdentityGUID, boolean isMergeUpdate, org.odpi.openmetadata.frameworks.openmetadata.properties.actors.UserIdentityProperties properties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • deleteUserIdentity

      void deleteUserIdentity(String userId, String externalSourceGUID, String externalSourceName, String userIdentityGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • addIdentityToProfile

      void addIdentityToProfile(String userId, String externalSourceGUID, String externalSourceName, String userIdentityGUID, String profileGUID, org.odpi.openmetadata.frameworks.openmetadata.properties.actors.ProfileIdentityProperties properties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • updateProfileIdentity

      void updateProfileIdentity(String userId, String externalSourceGUID, String externalSourceName, String userIdentityGUID, String profileGUID, boolean isMergeUpdate, org.odpi.openmetadata.frameworks.openmetadata.properties.actors.ProfileIdentityProperties properties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • removeIdentityFromProfile

      void removeIdentityFromProfile(String userId, String externalSourceGUID, String externalSourceName, String userIdentityGUID, String profileGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • findUserIdentities

      List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.UserIdentityElement> findUserIdentities(String userId, String searchString, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the list of user identity metadata elements that contain the search string. The search string is treated as a regular expression.
      Parameters:
      userId - calling user
      searchString - string to find in the properties
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      list of matching metadata elements
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getUserIdentitiesByName

      List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.UserIdentityElement> getUserIdentitiesByName(String userId, String name, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the list of user identity metadata elements with a matching qualified name. There are no wildcards supported on this request.
      Parameters:
      userId - calling user
      name - name to search for
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      list of matching metadata elements
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getUserIdentityByGUID

      org.odpi.openmetadata.frameworks.openmetadata.metadataelements.UserIdentityElement getUserIdentityByGUID(String userId, String userIdentityGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the userIdentity metadata element with the supplied unique identifier.
      Parameters:
      userId - calling user
      userIdentityGUID - unique identifier of the requested metadata element
      Returns:
      matching metadata element
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)