Package org.odpi.openmetadata.viewservices.securityofficer.server

Class SecurityOfficerRESTServices

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

  • Constructor Details

    • SecurityOfficerRESTServices

      public SecurityOfficerRESTServices()
      Default constructor

  • Method Details

    • setUserAccount

      public VoidResponse setUserAccount(String serverName, String platformGUID, UserAccountRequestBody requestBody)
      Set up a new user account or update an existing one. This is account is registered with the platform security connector. The user requires operator permission for the platform unless it is their own user account they are updating.
      Parameters:
      serverName - name of called server
      platformGUID - unique identifier of the platform
      requestBody - containing the user account properties.
      Returns:
      void or exceptions that occur when trying to create the connector: InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • getUserAccount

      public UserAccountResponse getUserAccount(String serverName, String platformGUID, String accountUserId)
      Return details of a user account registered with the platform security connector.
      Parameters:
      serverName - name of called server
      platformGUID - unique identifier of the platform
      accountUserId - name of the connector provider class
      Returns:
      user account bean or exceptions that occur when trying to create the connector: InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • deleteUserAccount

      public VoidResponse deleteUserAccount(String serverName, String platformGUID, String accountUserId)
      Clear the account for a user with the platform security connector.
      Parameters:
      serverName - name of called server
      platformGUID - unique identifier of the platform
      accountUserId - name of the connector provider class
      Returns:
      void or exceptions that occur when trying to create the connector: InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkGovernanceZones

      public VoidResponse linkGovernanceZones(String serverName, String governanceZoneGUID, String nestedGovernanceZoneGUID, NewRelationshipRequestBody requestBody)
      Attach governance zones in a hierarchy.
      Parameters:
      serverName - name of called server
      governanceZoneGUID - unique identifier of the parent governance zone.
      nestedGovernanceZoneGUID - unique identifier of the nested governance zone.
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachGovernanceZones

      public VoidResponse detachGovernanceZones(String serverName, String governanceZoneGUID, String nestedGovernanceZoneGUID, DeleteRelationshipRequestBody requestBody)
      Detach governance zone from a hierarchical relationship.
      Parameters:
      serverName - name of called server
      governanceZoneGUID - unique identifier of the parent governance zone.
      nestedGovernanceZoneGUID - unique identifier of the nested governance zone.
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.