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 and Description
void	addIdentityToProfile(String userId, String externalSourceGUID, String externalSourceName, String userIdentityGUID, String profileGUID) Link a user identity to a profile.
String	createUserIdentity(String userId, String externalSourceGUID, String externalSourceName, UserIdentityProperties newIdentity) Create a UserIdentity.
void	deleteUserIdentity(String userId, String externalSourceGUID, String externalSourceName, String userIdentityGUID) Remove a user identity object.
List<UserIdentityElement>	findUserIdentities(String userId, String searchString, int startFrom, int pageSize) Retrieve the list of user identity metadata elements that contain the search string.
List<UserIdentityElement>	getUserIdentitiesByName(String userId, String name, int startFrom, int pageSize) Retrieve the list of user identity metadata elements with a matching qualified name.
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	updateUserIdentity(String userId, String externalSourceGUID, String externalSourceName, String userIdentityGUID, boolean isMergeUpdate, UserIdentityProperties properties) Update a UserIdentity.

Method Detail

createUserIdentity

String createUserIdentity(String userId,
                          String externalSourceGUID,
                          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.

updateUserIdentity

void updateUserIdentity(String userId,
                        String externalSourceGUID,
                        String externalSourceName,
                        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(String userId,
                        String externalSourceGUID,
                        String externalSourceName,
                        String userIdentityGUID)
                 throws InvalidParameterException,
                        PropertyServerException,
                        UserNotAuthorizedException

Remove a user identity object. This will fail if a profile would be left without an associated user identity.

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(String userId,
                          String externalSourceGUID,
                          String externalSourceName,
                          String userIdentityGUID,
                          String profileGUID)
                   throws InvalidParameterException,
                          PropertyServerException,
                          UserNotAuthorizedException

Link a user identity to a profile. This will fail if the user identity is already 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

userIdentityGUID - additional userId for the profile.

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.

removeIdentityFromProfile

void removeIdentityFromProfile(String userId,
                               String externalSourceGUID,
                               String externalSourceName,
                               String userIdentityGUID,
                               String profileGUID)
                        throws InvalidParameterException,
                               PropertyServerException,
                               UserNotAuthorizedException

Unlink a user identity from a profile. This will fail if the profile would be left without an associated user identity.

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.

findUserIdentities

List<UserIdentityElement> findUserIdentities(String userId,
                                             String searchString,
                                             int startFrom,
                                             int pageSize)
                                      throws InvalidParameterException,
                                             UserNotAuthorizedException,
                                             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:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getUserIdentitiesByName

List<UserIdentityElement> getUserIdentitiesByName(String userId,
                                                  String name,
                                                  int startFrom,
                                                  int pageSize)
                                           throws InvalidParameterException,
                                                  UserNotAuthorizedException,
                                                  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:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getUserIdentityByGUID

UserIdentityElement getUserIdentityByGUID(String userId,
                                          String userIdentityGUID)
                                   throws InvalidParameterException,
                                          UserNotAuthorizedException,
                                          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:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)