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 profileGUID, UserIdentityRequestBody requestBody) Link a user identity to a profile.
VoidResponse	createUserIdentity(String serverName, String userId, UserIdentityRequestBody requestBody) Create a UserIdentity.
VoidResponse	removeIdentityFromProfile(String serverName, String userId, String profileGUID, UserIdentityRequestBody requestBody) Remove a user identity object.
VoidResponse	removeUserIdentity(String serverName, String userId, UserIdentityRequestBody requestBody) Remove a user identity object.

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

@RequestMapping(method=POST,
                path="/user-identity")
public VoidResponse 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:

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

@RequestMapping(method=POST,
                path="/personal-profiles/{profileGUID}/user-identity")
public VoidResponse addIdentityToProfile(@PathVariable
                                                                                                                                             String serverName,
                                                                                                                                             @PathVariable
                                                                                                                                             String userId,
                                                                                                                                             @PathVariable
                                                                                                                                             String profileGUID,
                                                                                                                                             @RequestBody
                                                                                                                                             UserIdentityRequestBody 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.

profileGUID - the profile to add the identity to.

requestBody - additional userId for the profile.

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

@RequestMapping(method=POST,
                path="/personal-profiles/{profileGUID}/user-identity/delete")
public VoidResponse removeIdentityFromProfile(@PathVariable
                                                                                                                                                         String serverName,
                                                                                                                                                         @PathVariable
                                                                                                                                                         String userId,
                                                                                                                                                         @PathVariable
                                                                                                                                                         String profileGUID,
                                                                                                                                                         @RequestBody
                                                                                                                                                         UserIdentityRequestBody 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.

profileGUID - profile to remove it from.

requestBody - user identity to remove.

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.

removeUserIdentity

@RequestMapping(method=POST,
                path="/user-identity/delete")
public VoidResponse removeUserIdentity(@PathVariable
                                                                                                                  String serverName,
                                                                                                                  @PathVariable
                                                                                                                  String userId,
                                                                                                                  @RequestBody
                                                                                                                  UserIdentityRequestBody 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.

requestBody - user identity to remove.

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.