Package org.odpi.openmetadata.platformservices.server.spring

Class OMAGServerPlatformSecurityResource

java.lang.Object
org.odpi.openmetadata.platformservices.server.spring.OMAGServerPlatformSecurityResource
@RestController @RequestMapping("/open-metadata/platform-services/users/{userId}/server-platform/security") public class OMAGServerPlatformSecurityResource extends Object
OMAGServerPlatformSecurityResource provides the API to configure the security connector that validates platform requests that do not reference an OMAG server. These requests are used by the team that run the platform as a service.

  • Constructor Details

    • OMAGServerPlatformSecurityResource

      public OMAGServerPlatformSecurityResource()

  • Method Details

    • setPlatformSecurityConnection

      @PostMapping(path="/connection") public VoidResponse setPlatformSecurityConnection(@PathVariable String userId, @RequestBody PlatformSecurityRequestBody requestBody)
      Set up a platform metadata security connector
      Parameters:
      userId - calling user.
      requestBody - requestBody used to create and configure the connector that performs platform security
      Returns:
      void response

    • getPlatformSecurityConnection

      @GetMapping(path="/connection") public ConnectionResponse getPlatformSecurityConnection(@PathVariable String userId)
      Return the connection object for platform metadata security connector. Null is returned if no platform security has been set up.
      Parameters:
      userId - calling user
      Returns:
      connection response

    • clearPlatformSecurityConnection

      @DeleteMapping(path="/connection") public VoidResponse clearPlatformSecurityConnection(@PathVariable String userId)
      Clear the connection object for platform security. This means there is no platform security set up.
      Parameters:
      userId - calling user
      Returns:
      void response