Package org.odpi.openmetadata.accessservices.communityprofile.server

Class UserIdentityRESTServices

java.lang.Object
org.odpi.openmetadata.accessservices.communityprofile.server.UserIdentityRESTServices
public class UserIdentityRESTServices extends Object
UserIdentityResource provides the APIs for maintaining user identities and their relationships with profiles.

  • Constructor Summary

    Constructors
    Constructor
    Description
    UserIdentityRESTServices()
    Default constructor

  • Method Summary

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

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • UserIdentityRESTServices

      public UserIdentityRESTServices()
      Default constructor

  • Method Details

    • createUserIdentity

      public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse createUserIdentity(String serverName, String userId, org.odpi.openmetadata.commonservices.ffdc.rest.ReferenceableRequestBody 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.

    • updateUserIdentity

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse updateUserIdentity(String serverName, String userId, String userIdentityGUID, boolean isMergeUpdate, org.odpi.openmetadata.commonservices.ffdc.rest.ReferenceableRequestBody 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

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse deleteUserIdentity(String serverName, String userId, String userIdentityGUID, org.odpi.openmetadata.commonservices.ffdc.rest.ExternalSourceRequestBody requestBody)
      Remove a user identity object.
      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

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse addIdentityToProfile(String serverName, String userId, String userIdentityGUID, String profileGUID, org.odpi.openmetadata.commonservices.ffdc.rest.RelationshipRequestBody requestBody)
      Link a user identity 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.

    • updateIdentityProfile

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse updateIdentityProfile(String serverName, String userId, String userIdentityGUID, String profileGUID, boolean isMergeUpdate, org.odpi.openmetadata.commonservices.ffdc.rest.RelationshipRequestBody requestBody)
      Link a user identity 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.
      isMergeUpdate - should the supplied properties be overlaid on the existing properties (true) or replace them (false
      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

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse removeIdentityFromProfile(String serverName, String userId, String userIdentityGUID, String profileGUID, org.odpi.openmetadata.commonservices.ffdc.rest.ExternalSourceRequestBody requestBody)
      Remove a user identity object.
      Parameters:
      serverName - name of target server
      userId - the name of the calling user.
      userIdentityGUID - unique identifier of the UserIdentity
      profileGUID - profile to remove it from.
      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

      public org.odpi.openmetadata.commonservices.ffdc.rest.UserIdentitiesResponse findUserIdentities(String serverName, String userId, int startFrom, int pageSize, org.odpi.openmetadata.commonservices.ffdc.rest.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

      public org.odpi.openmetadata.commonservices.ffdc.rest.UserIdentitiesResponse getUserIdentitiesByName(String serverName, String userId, int startFrom, int pageSize, org.odpi.openmetadata.commonservices.ffdc.rest.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 org.odpi.openmetadata.commonservices.ffdc.rest.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)