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

Method Summary

Modifier and Type	Method and Description
void	addIdentityToProfile(String userId, String profileGUID, String newIdentity) Link a user identity to a profile.
void	createUserIdentity(String userId, String newIdentity) Create a UserIdentity.
void	removeIdentityFromProfile(String userId, String profileGUID, String obsoleteIdentity) Remove a user identity object.
void	removeUserIdentity(String userId, String obsoleteIdentity) Remove a user identity object.

Method Detail

createUserIdentity

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

Create a UserIdentity. This is not connected to a profile.

Parameters:

userId - the name of the calling user.

newIdentity - userId 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.

addIdentityToProfile

void addIdentityToProfile(String userId,
                          String profileGUID,
                          String newIdentity)
                   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.

profileGUID - the profile to add the identity to.

newIdentity - additional userId for the profile.

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 profileGUID,
                               String obsoleteIdentity)
                        throws InvalidParameterException,
                               PropertyServerException,
                               UserNotAuthorizedException

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

Parameters:

userId - the name of the calling user.

profileGUID - profile to remove it from.

obsoleteIdentity - user identity to remove.

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.

removeUserIdentity

void removeUserIdentity(String userId,
                        String obsoleteIdentity)
                 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.

obsoleteIdentity - user identity to remove.

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.