Package org.odpi.openmetadata.viewservices.actormanager.server

Class ActorManagerRESTServices

java.lang.Object
org.odpi.openmetadata.tokencontroller.TokenController
org.odpi.openmetadata.viewservices.actormanager.server.ActorManagerRESTServices
public class ActorManagerRESTServices extends TokenController
The ActorManagerRESTServices provides the server-side implementation of the Actor Manager Open Metadata View Service (OMVS). This interface provides access to a person's profile, roles and network.

  • Constructor Details

    • ActorManagerRESTServices

      public ActorManagerRESTServices()
      Default constructor

  • Method Details

    • createActorProfile

      public GUIDResponse createActorProfile(String serverName, String viewServiceURLMarker, NewElementRequestBody requestBody)
      Create an actor profile.
      Parameters:
      serverName - name of called server.
      viewServiceURLMarker - view service URL marker
      requestBody - properties for the actor profile.
      Returns:
      unique identifier of the newly created element 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.

    • createActorProfileFromTemplate

      public GUIDResponse createActorProfileFromTemplate(String serverName, String viewServiceURLMarker, TemplateRequestBody requestBody)
      Create a new metadata element to represent an actor profile using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new element.
      Parameters:
      serverName - calling user
      viewServiceURLMarker - view service URL marker
      requestBody - properties that override the template
      Returns:
      unique identifier of the new metadata element 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)

    • updateActorProfile

      public VoidResponse updateActorProfile(String serverName, String viewServiceURLMarker, String actorProfileGUID, boolean replaceAllProperties, UpdateElementRequestBody requestBody)
      Update the properties of an actor profile.
      Parameters:
      serverName - name of called server.
      viewServiceURLMarker - view service URL marker
      actorProfileGUID - unique identifier of the actor profile (returned from create)
      replaceAllProperties - flag to indicate whether to completely replace the existing properties with the new properties, or just update the individual properties specified on the request.
      requestBody - properties for the new element.
      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.

    • linkLocationToProfile

      public VoidResponse linkLocationToProfile(String serverName, String viewServiceURLMarker, String actorProfileGUID, String locationGUID, RelationshipRequestBody requestBody)
      Attach a profile to a location.
      Parameters:
      serverName - name of called server
      viewServiceURLMarker - view service URL marker
      actorProfileGUID - unique identifier of the actor profile
      locationGUID - unique identifier of the location
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachLocationFromProfile

      public VoidResponse detachLocationFromProfile(String serverName, String viewServiceURLMarker, String actorProfileGUID, String locationGUID, MetadataSourceRequestBody requestBody)
      Detach an actor profile from a location.
      Parameters:
      serverName - name of called server
      viewServiceURLMarker - view service URL marker
      actorProfileGUID - unique identifier of the actor profile
      locationGUID - unique identifier of the location
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkPeerPerson

      public VoidResponse linkPeerPerson(String serverName, String viewServiceURLMarker, String personOneGUID, String personTwoGUID, RelationshipRequestBody requestBody)
      Attach a person profile to one of its peers.
      Parameters:
      serverName - name of called server
      viewServiceURLMarker - view service URL marker
      personOneGUID - unique identifier of the first actor profile
      personTwoGUID - unique identifier of the second actor profile
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachPeerPerson

      public VoidResponse detachPeerPerson(String serverName, String viewServiceURLMarker, String personOneGUID, String personTwoGUID, MetadataSourceRequestBody requestBody)
      Detach a person profile from one of its peers.
      Parameters:
      serverName - name of called server
      viewServiceURLMarker - view service URL marker
      personOneGUID - unique identifier of the first person profile
      personTwoGUID - unique identifier of the second person profile
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkTeamStructure

      public VoidResponse linkTeamStructure(String serverName, String viewServiceURLMarker, String superTeamGUID, String subteamGUID, RelationshipRequestBody requestBody)
      Attach a super team to a subteam.
      Parameters:
      serverName - name of called server
      viewServiceURLMarker - view service URL marker
      superTeamGUID - unique identifier of the super team
      subteamGUID - unique identifier of the subteam
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachTeamStructure

      public VoidResponse detachTeamStructure(String serverName, String viewServiceURLMarker, String superTeamGUID, String subteamGUID, MetadataSourceRequestBody requestBody)
      Detach a super team from a subteam.
      Parameters:
      serverName - name of called server
      viewServiceURLMarker - view service URL marker
      superTeamGUID - unique identifier of the super team
      subteamGUID - unique identifier of the subteam
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkAssetToProfile

      public VoidResponse linkAssetToProfile(String serverName, String viewServiceURLMarker, String assetGUID, String itProfileGUID, RelationshipRequestBody requestBody)
      Attach an asset to an IT profile.
      Parameters:
      serverName - name of called server
      viewServiceURLMarker - view service URL marker
      assetGUID - unique identifier of the asset
      itProfileGUID - unique identifier of the IT profile
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachAssetFromProfile

      public VoidResponse detachAssetFromProfile(String serverName, String viewServiceURLMarker, String assetGUID, String itProfileGUID, MetadataSourceRequestBody requestBody)
      Detach an asset from an IT profile.
      Parameters:
      serverName - name of called server
      viewServiceURLMarker - view service URL marker
      assetGUID - unique identifier of the asset
      itProfileGUID - unique identifier of the IT profile
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkTeamToMembershipRole

      public VoidResponse linkTeamToMembershipRole(String serverName, String viewServiceURLMarker, String teamGUID, String personRoleGUID, RelationshipRequestBody requestBody)
      Attach a team to its membership role.
      Parameters:
      serverName - name of called server
      viewServiceURLMarker - view service URL marker
      teamGUID - unique identifier of the team
      personRoleGUID - unique identifier of the associated person role
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachTeamFromMembershipRole

      public VoidResponse detachTeamFromMembershipRole(String serverName, String viewServiceURLMarker, String teamGUID, String personRoleGUID, MetadataSourceRequestBody requestBody)
      Detach a team profile from its membership role.
      Parameters:
      serverName - name of called server
      viewServiceURLMarker - view service URL marker
      teamGUID - unique identifier of the team
      personRoleGUID - unique identifier of the associated person role
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkTeamToLeadershipRole

      public VoidResponse linkTeamToLeadershipRole(String serverName, String viewServiceURLMarker, String teamGUID, String personRoleGUID, RelationshipRequestBody requestBody)
      Attach a team to its leadership role.
      Parameters:
      serverName - name of called server
      viewServiceURLMarker - view service URL marker
      teamGUID - unique identifier of the team
      personRoleGUID - unique identifier of the associated person role
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachTeamFromLeadershipRole

      public VoidResponse detachTeamFromLeadershipRole(String serverName, String viewServiceURLMarker, String teamGUID, String personRoleGUID, MetadataSourceRequestBody requestBody)
      Detach a team profile from its leadership role.
      Parameters:
      serverName - name of called server
      viewServiceURLMarker - view service URL marker
      teamGUID - unique identifier of the team
      personRoleGUID - unique identifier of the associated person role
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • deleteActorProfile

      public VoidResponse deleteActorProfile(String serverName, String viewServiceURLMarker, String actorProfileGUID, boolean cascadedDelete, MetadataSourceRequestBody requestBody)
      Delete an actor profile.
      Parameters:
      serverName - name of called server
      viewServiceURLMarker - view service URL marker
      actorProfileGUID - unique identifier of the element to delete
      cascadedDelete - can actor profiles be deleted if data fields are attached?
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • getActorProfilesByName

      public ActorProfilesResponse getActorProfilesByName(String serverName, String viewServiceURLMarker, int startFrom, int pageSize, FilterRequestBody requestBody)
      Retrieve the list of actor profile metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      viewServiceURLMarker - view service URL marker
      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)

    • getActorProfileByGUID

      public ActorProfileResponse getActorProfileByGUID(String serverName, String viewServiceURLMarker, String actorProfileGUID, AnyTimeRequestBody requestBody)
      Retrieve the list of actor profile metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      viewServiceURLMarker - view service URL marker
      actorProfileGUID - unique identifier of the required element
      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)

    • findActorProfiles

      public ActorProfilesResponse findActorProfiles(String serverName, String viewServiceURLMarker, boolean startsWith, boolean endsWith, boolean ignoreCase, int startFrom, int pageSize, FilterRequestBody requestBody)
      Retrieve the list of actor profile metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      viewServiceURLMarker - view service URL marker
      startsWith - does the value start with the supplied string?
      endsWith - does the value end with the supplied string?
      ignoreCase - should the search ignore case?
      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)

    • createActorRole

      public GUIDResponse createActorRole(String serverName, String viewServiceURLMarker, NewElementRequestBody requestBody)
      Create an actor role.
      Parameters:
      serverName - name of called server.
      viewServiceURLMarker - view service URL marker
      requestBody - properties for the actor role.
      Returns:
      unique identifier of the newly created element 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.

    • createActorRoleFromTemplate

      public GUIDResponse createActorRoleFromTemplate(String serverName, String viewServiceURLMarker, TemplateRequestBody requestBody)
      Create a new metadata element to represent an actor role using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new element.
      Parameters:
      serverName - calling user
      viewServiceURLMarker - view service URL marker
      requestBody - properties that override the template
      Returns:
      unique identifier of the new metadata element 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)

    • updateActorRole

      public VoidResponse updateActorRole(String serverName, String viewServiceURLMarker, String actorRoleGUID, boolean replaceAllProperties, UpdateElementRequestBody requestBody)
      Update the properties of an actor role.
      Parameters:
      serverName - name of called server.
      viewServiceURLMarker - view service URL marker
      actorRoleGUID - unique identifier of the actor role (returned from create)
      replaceAllProperties - flag to indicate whether to completely replace the existing properties with the new properties, or just update the individual properties specified on the request.
      requestBody - properties for the new element.
      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.

    • linkPersonRoleToProfile

      public VoidResponse linkPersonRoleToProfile(String serverName, String viewServiceURLMarker, String personRoleGUID, String personProfileGUID, RelationshipRequestBody requestBody)
      Attach a team role to a team profile.
      Parameters:
      serverName - name of called server
      viewServiceURLMarker - view service URL marker
      personRoleGUID - unique identifier of the person role
      personProfileGUID - unique identifier of the person profile
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachPersonRoleFromProfile

      public VoidResponse detachPersonRoleFromProfile(String serverName, String viewServiceURLMarker, String personRoleGUID, String personProfileGUID, MetadataSourceRequestBody requestBody)
      Detach a team role from a team profile.
      Parameters:
      serverName - name of called server
      viewServiceURLMarker - view service URL marker
      personRoleGUID - unique identifier of the person role
      personProfileGUID - unique identifier of the person profile
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkTeamRoleToProfile

      public VoidResponse linkTeamRoleToProfile(String serverName, String viewServiceURLMarker, String teamRoleGUID, String teamProfileGUID, RelationshipRequestBody requestBody)
      Attach a team role to a team profile.
      Parameters:
      serverName - name of called server
      viewServiceURLMarker - view service URL marker
      teamRoleGUID - unique identifier of the team role
      teamProfileGUID - unique identifier of the team profile
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachTeamRoleFromProfile

      public VoidResponse detachTeamRoleFromProfile(String serverName, String viewServiceURLMarker, String teamRoleGUID, String teamProfileGUID, MetadataSourceRequestBody requestBody)
      Detach a team role from a team profile.
      Parameters:
      serverName - name of called server
      viewServiceURLMarker - view service URL marker
      teamRoleGUID - unique identifier of the team role
      teamProfileGUID - unique identifier of the team profile
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkITProfileRoleToProfile

      public VoidResponse linkITProfileRoleToProfile(String serverName, String viewServiceURLMarker, String itProfileRoleGUID, String itProfileGUID, RelationshipRequestBody requestBody)
      Attach an IT profile role to an IT profile.
      Parameters:
      serverName - name of called server
      viewServiceURLMarker - view service URL marker
      itProfileRoleGUID - unique identifier of the IT profile role
      itProfileGUID - unique identifier of the IT profile
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachITProfileRoleFromProfile

      public VoidResponse detachITProfileRoleFromProfile(String serverName, String viewServiceURLMarker, String itProfileRoleGUID, String itProfileGUID, MetadataSourceRequestBody requestBody)
      Detach an IT profile role from an IT profile.
      Parameters:
      serverName - name of called server
      viewServiceURLMarker - view service URL marker
      itProfileRoleGUID - unique identifier of the IT profile role
      itProfileGUID - unique identifier of the IT profile
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • deleteActorRole

      public VoidResponse deleteActorRole(String serverName, String viewServiceURLMarker, String actorRoleGUID, boolean cascadedDelete, MetadataSourceRequestBody requestBody)
      Delete an actor role.
      Parameters:
      serverName - name of called server
      viewServiceURLMarker - view service URL marker
      actorRoleGUID - unique identifier of the element to delete
      cascadedDelete - can actor roles be deleted if data fields are attached?
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • getActorRolesByName

      public ActorRolesResponse getActorRolesByName(String serverName, String viewServiceURLMarker, int startFrom, int pageSize, FilterRequestBody requestBody)
      Retrieve the list of actor role metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      viewServiceURLMarker - view service URL marker
      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)

    • getActorRoleByGUID

      public ActorRoleResponse getActorRoleByGUID(String serverName, String viewServiceURLMarker, String actorRoleGUID, AnyTimeRequestBody requestBody)
      Retrieve the list of actor role metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      viewServiceURLMarker - view service URL marker
      actorRoleGUID - unique identifier of the required element
      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)

    • findActorRoles

      public ActorRolesResponse findActorRoles(String serverName, String viewServiceURLMarker, boolean startsWith, boolean endsWith, boolean ignoreCase, int startFrom, int pageSize, FilterRequestBody requestBody)
      Retrieve the list of actor role metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      viewServiceURLMarker - view service URL marker
      startsWith - does the value start with the supplied string?
      endsWith - does the value end with the supplied string?
      ignoreCase - should the search ignore case?
      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)

    • createUserIdentity

      public GUIDResponse createUserIdentity(String serverName, String viewServiceURLMarker, NewElementRequestBody requestBody)
      Create a user identity.
      Parameters:
      serverName - name of called server.
      viewServiceURLMarker - view service URL marker
      requestBody - properties for the user identity.
      Returns:
      unique identifier of the newly created element 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.

    • createUserIdentityFromTemplate

      public GUIDResponse createUserIdentityFromTemplate(String serverName, String viewServiceURLMarker, TemplateRequestBody requestBody)
      Create a new metadata element to represent a user identity using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new element.
      Parameters:
      serverName - calling user
      viewServiceURLMarker - view service URL marker
      requestBody - properties that override the template
      Returns:
      unique identifier of the new metadata element 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)

    • updateUserIdentity

      public VoidResponse updateUserIdentity(String serverName, String viewServiceURLMarker, String userIdentityGUID, boolean replaceAllProperties, UpdateElementRequestBody requestBody)
      Update the properties of a user identity.
      Parameters:
      serverName - name of called server.
      viewServiceURLMarker - view service URL marker
      userIdentityGUID - unique identifier of the user identity (returned from create)
      replaceAllProperties - flag to indicate whether to completely replace the existing properties with the new properties, or just update the individual properties specified on the request.
      requestBody - properties for the new element.
      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.

    • linkIdentityToProfile

      public VoidResponse linkIdentityToProfile(String serverName, String viewServiceURLMarker, String userIdentityGUID, String profileGUID, RelationshipRequestBody requestBody)
      Attach a profile to a user identity.
      Parameters:
      serverName - name of called server
      viewServiceURLMarker - view service URL marker
      userIdentityGUID - unique identifier of the parent
      profileGUID - unique identifier of the actor profile
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachProfileIdentity

      public VoidResponse detachProfileIdentity(String serverName, String viewServiceURLMarker, String userIdentityGUID, String profileGUID, MetadataSourceRequestBody requestBody)
      Detach an actor profile from a user identity.
      Parameters:
      serverName - name of called server
      viewServiceURLMarker - view service URL marker
      userIdentityGUID - unique identifier of the parent actor profile
      profileGUID - unique identifier of the nested actor profile
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • addSecurityGroupMembership

      public VoidResponse addSecurityGroupMembership(String serverName, String viewServiceURLMarker, String userIdentityGUID, ClassificationRequestBody requestBody)
      Add the SecurityGroupMembership classification to the user identity.
      Parameters:
      serverName - name of called server
      viewServiceURLMarker - view service URL marker
      userIdentityGUID - unique identifier of the user identity
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • updateSecurityGroupMembership

      public VoidResponse updateSecurityGroupMembership(String serverName, String viewServiceURLMarker, String userIdentityGUID, ClassificationRequestBody requestBody)
      Update the SecurityGroupMembership classification to the user identity.
      Parameters:
      serverName - name of called server
      viewServiceURLMarker - view service URL marker
      userIdentityGUID - unique identifier of the user identity
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • removeAllSecurityGroupMembership

      public VoidResponse removeAllSecurityGroupMembership(String serverName, String viewServiceURLMarker, String userIdentityGUID, MetadataSourceRequestBody requestBody)
      Detach a user identity from a supporting user identity.
      Parameters:
      serverName - name of called server
      viewServiceURLMarker - view service URL marker
      userIdentityGUID - unique identifier of the first user identity
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or 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 VoidResponse deleteUserIdentity(String serverName, String viewServiceURLMarker, String userIdentityGUID, boolean cascadedDelete, MetadataSourceRequestBody requestBody)
      Delete a user identity.
      Parameters:
      serverName - name of called server
      viewServiceURLMarker - view service URL marker
      userIdentityGUID - unique identifier of the element to delete
      cascadedDelete - can user identities be deleted if data fields are attached?
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • getUserIdentitiesByName

      public UserIdentitiesResponse getUserIdentitiesByName(String serverName, String viewServiceURLMarker, int startFrom, int pageSize, FilterRequestBody requestBody)
      Retrieve the list of user identity metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      viewServiceURLMarker - view service URL marker
      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)

    • getUserIdentityByGUID

      public UserIdentityResponse getUserIdentityByGUID(String serverName, String viewServiceURLMarker, String userIdentityGUID, AnyTimeRequestBody requestBody)
      Retrieve the list of user identity metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      viewServiceURLMarker - view service URL marker
      userIdentityGUID - unique identifier of the required element
      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)

    • findUserIdentities

      public UserIdentitiesResponse findUserIdentities(String serverName, String viewServiceURLMarker, boolean startsWith, boolean endsWith, boolean ignoreCase, int startFrom, int pageSize, FilterRequestBody requestBody)
      Retrieve the list of user identity metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      viewServiceURLMarker - view service URL marker
      startsWith - does the value start with the supplied string?
      endsWith - does the value end with the supplied string?
      ignoreCase - should the search ignore case?
      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)