org.odpi.openmetadata.accessservices.communityprofile

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

Method Summary

Modifier and Type	Method and Description
void	addIdentityToProfile(String userId, String newIdentity) Create or update the profile for the requesting user.
void	createUserIdentity(String userId, String newIdentity) Create a UserIdentity.
void	removeIdentityFromProfile(String userId, String newIdentity) Create or update the profile for the requesting user.

Method Detail

createUserIdentity

void createUserIdentity(String userId,
                        String newIdentity)
                 throws InvalidParameterException,
                        NoProfileForUserException,
                        PropertyServerException,
                        UserNotAuthorizedException

Create a UserIdentity.

Parameters:

userId - the name of the calling user.

newIdentity - userId for the new userIdentity.

Throws:

InvalidParameterException - one of the parameters is invalid.

NoProfileForUserException - the user does not have a profile.

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 newIdentity)
                   throws InvalidParameterException,
                          NoProfileForUserException,
                          PropertyServerException,
                          UserNotAuthorizedException

Create or update the profile for the requesting user.

Parameters:

userId - the name of the calling user.

newIdentity - additional userId for the profile.

Throws:

InvalidParameterException - one of the parameters is invalid.

NoProfileForUserException - the user does not have a profile.

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 newIdentity)
                        throws InvalidParameterException,
                               NoProfileForUserException,
                               PropertyServerException,
                               UserNotAuthorizedException

Create or update the profile for the requesting user.

Parameters:

userId - the name of the calling user.

newIdentity - additional userId for the profile.

Throws:

InvalidParameterException - one of the parameters is invalid.

NoProfileForUserException - the user does not have a profile.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.