org.odpi.openmetadata.accessservices.communityprofile.server.spring

Class UserIdentityResource

java.lang.Object

org.odpi.openmetadata.accessservices.communityprofile.server.spring.UserIdentityResource

@RestController
 @RequestMapping(value="/servers/{serverName}/open-metadata/access-services/community-profile/users/{userId}")
public class UserIdentityResource
extends Object

UserIdentityResource provides the APIs for maintaining user identities and their relationships with profiles.

Constructor Summary

Constructors

Constructor and Description
UserIdentityResource()

Method Summary

Modifier and Type	Method and Description
VoidResponse	addIdentityToProfile(String serverName, String userId, String userIdentityGUID, String profileGUID, MetadataSourceRequestBody requestBody) Link a user identity to a profile.
GUIDResponse	createUserIdentity(String serverName, String userId, UserIdentityRequestBody requestBody) Create a UserIdentity.
VoidResponse	deleteUserIdentity(String serverName, String userId, String userIdentityGUID, MetadataSourceRequestBody requestBody) Remove a user identity object.
UserIdentityListResponse	findUserIdentities(String serverName, String userId, int startFrom, int pageSize, SearchStringRequestBody requestBody) Retrieve the list of user identity metadata elements that contain the search string.
UserIdentityListResponse	getUserIdentitiesByName(String serverName, String userId, int startFrom, int pageSize, NameRequestBody requestBody) Retrieve the list of user identity metadata elements with a matching qualified name.
UserIdentityResponse	getUserIdentityByGUID(String serverName, String userId, String userIdentityGUID) Retrieve the userIdentity metadata element with the supplied unique identifier.
VoidResponse	removeIdentityFromProfile(String serverName, String userId, String userIdentityGUID, String profileGUID, MetadataSourceRequestBody requestBody) Remove a user identity object.
VoidResponse	updateUserIdentity(String serverName, String userId, String userIdentityGUID, boolean isMergeUpdate, UserIdentityRequestBody requestBody) Update a UserIdentity.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UserIdentityResource

public UserIdentityResource()

Method Detail

createUserIdentity

@PostMapping(path="/user-identities")
public GUIDResponse createUserIdentity(@PathVariable
                                                                             String serverName,
                                                                             @PathVariable
                                                                             String userId,
                                                                             @RequestBody
                                                                             UserIdentityRequestBody requestBody)

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

Parameters:

serverName - name of target server

userId - the name of the calling user.

requestBody - userId for the new userIdentity.

Returns:

guid or InvalidParameterException - one of the parameters is invalid or PropertyServerException - there is a problem retrieving information from the property server(s) or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

updateUserIdentity

@PostMapping(path="/user-identities/{userIdentityGUID}")
public VoidResponse updateUserIdentity(@PathVariable
                                                                                                String serverName,
                                                                                                @PathVariable
                                                                                                String userId,
                                                                                                @PathVariable
                                                                                                String userIdentityGUID,
                                                                                                @RequestParam
                                                                                                boolean isMergeUpdate,
                                                                                                @RequestBody
                                                                                                UserIdentityRequestBody requestBody)

Update a UserIdentity.

Parameters:

serverName - name of target server

userId - the name of the calling user

userIdentityGUID - unique identifier of the UserIdentity

isMergeUpdate - should the supplied properties be overlaid on the existing properties (true) or replace them (false

requestBody - updated properties for the new userIdentity

Returns:

void or 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

@PostMapping(path="/user-identities/{userIdentityGUID}/delete")
public VoidResponse deleteUserIdentity(@PathVariable
                                                                                                       String serverName,
                                                                                                       @PathVariable
                                                                                                       String userId,
                                                                                                       @PathVariable
                                                                                                       String userIdentityGUID,
                                                                                                       @RequestBody
                                                                                                       MetadataSourceRequestBody requestBody)

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

Parameters:

serverName - name of target server

userId - the name of the calling user.

userIdentityGUID - unique identifier of the UserIdentity

requestBody - external source identifiers

Returns:

void or InvalidParameterException - one of the parameters is invalid or PropertyServerException - there is a problem retrieving information from the property server(s) or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

addIdentityToProfile

@PostMapping(path="/user-identities/{userIdentityGUID}/personal-profiles/{profileGUID}/link")
public VoidResponse addIdentityToProfile(@PathVariable
                                                                                                                                       String serverName,
                                                                                                                                       @PathVariable
                                                                                                                                       String userId,
                                                                                                                                       @PathVariable
                                                                                                                                       String userIdentityGUID,
                                                                                                                                       @PathVariable
                                                                                                                                       String profileGUID,
                                                                                                                                       @RequestBody
                                                                                                                                       MetadataSourceRequestBody requestBody)

Link a user identity to a profile. This will fail if the user identity is already connected to a profile.

Parameters:

serverName - name of target server

userId - the name of the calling user.

userIdentityGUID - unique identifier of the UserIdentity

profileGUID - the profile to add the identity to.

requestBody - external source identifiers

Returns:

void or InvalidParameterException - one of the parameters is invalid or PropertyServerException - there is a problem retrieving information from the property server(s) or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

removeIdentityFromProfile

@PostMapping(path="/user-identities/{userIdentityGUID}/profiles/{profileGUID}/unlink")
public VoidResponse removeIdentityFromProfile(@PathVariable
                                                                                                                                     String serverName,
                                                                                                                                     @PathVariable
                                                                                                                                     String userId,
                                                                                                                                     @PathVariable
                                                                                                                                     String userIdentityGUID,
                                                                                                                                     @PathVariable
                                                                                                                                     String profileGUID,
                                                                                                                                     @RequestBody
                                                                                                                                     MetadataSourceRequestBody requestBody)

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

Parameters:

serverName - name of target server

userId - the name of the calling user.

userIdentityGUID - unique identifier of the UserIdentity

profileGUID - the profile to add the identity to.

requestBody - external source identifiers

Returns:

void or InvalidParameterException - one of the parameters is invalid or PropertyServerException - there is a problem retrieving information from the property server(s) or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

findUserIdentities

@PostMapping(path="/user-identities/by-search-string")
public UserIdentityListResponse findUserIdentities(@PathVariable
                                                                                                          String serverName,
                                                                                                          @PathVariable
                                                                                                          String userId,
                                                                                                          @RequestParam
                                                                                                          int startFrom,
                                                                                                          @RequestParam
                                                                                                          int pageSize,
                                                                                                          @RequestBody
                                                                                                          SearchStringRequestBody requestBody)

Retrieve the list of user identity metadata elements that contain the search string. The search string is treated as a regular expression.

Parameters:

serverName - name of target server

userId - calling user

startFrom - paging start point

pageSize - maximum results that can be returned

requestBody - string to find in the properties

Returns:

list of matching metadata elements or 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

@PostMapping(path="/user-identities/by-name")
public UserIdentityListResponse getUserIdentitiesByName(@PathVariable
                                                                                                      String serverName,
                                                                                                      @PathVariable
                                                                                                      String userId,
                                                                                                      @RequestParam
                                                                                                      int startFrom,
                                                                                                      @RequestParam
                                                                                                      int pageSize,
                                                                                                      @RequestBody
                                                                                                      NameRequestBody requestBody)

Retrieve the list of user identity metadata elements with a matching qualified name. There are no wildcards supported on this request.

Parameters:

serverName - name of target server

userId - calling user

startFrom - paging start point

pageSize - maximum results that can be returned

requestBody - name to search for

Returns:

list of matching metadata elements 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

public UserIdentityResponse getUserIdentityByGUID(String serverName,
                                                  String userId,
                                                  String userIdentityGUID)

Retrieve the userIdentity metadata element with the supplied unique identifier.

Parameters:

serverName - name of target server

userId - calling user

userIdentityGUID - unique identifier of the requested metadata element

Returns:

matching metadata element or 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)