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/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(@RequestParam(required=false) String delegatingUserId, @RequestBody PlatformSecurityRequestBody requestBody)
      Set up a platform metadata security connector
      Parameters:
      delegatingUserId - external userId making request
      requestBody - requestBody used to create and configure the connector that performs platform security
      Returns:
      void response

    • getPlatformSecurityConnection

      @GetMapping(path="/connection") public ConnectionResponse getPlatformSecurityConnection(@RequestParam(required=false) String delegatingUserId)
      Return the connection object for platform metadata security connector. Null is returned if no platform security has been set up.
      Parameters:
      delegatingUserId - external userId making request
      Returns:
      connection response

    • clearPlatformSecurityConnection

      @DeleteMapping(path="/connection") public VoidResponse clearPlatformSecurityConnection(@RequestParam(required=false) String delegatingUserId)
      Clear the connection object for platform security. This means there is no platform security set up.
      Parameters:
      delegatingUserId - external userId making request
      Returns:
      void response

    • setUserAccount

      @PostMapping(path="/user-accounts") public VoidResponse setUserAccount(@RequestParam(required=false) String delegatingUserId, @RequestBody UserAccountRequestBody requestBody)
      Set up a user account in the platform metadata security connector
      Parameters:
      delegatingUserId - external userId making request
      requestBody - requestBody used to create and configure the connector that performs platform security
      Returns:
      void response

    • getUserAccount

      @GetMapping(path="/user-accounts/{accountUserId}") public UserAccountResponse getUserAccount(@PathVariable String accountUserId, @RequestParam(required=false) String delegatingUserId)
      Return the user account object for the requested user from the platform metadata security connector. Null is returned if no platform security or user account has been set up.
      Parameters:
      accountUserId - user id of the account
      delegatingUserId - external userId making request
      Returns:
      user account response

    • deleteUserAccount

      @DeleteMapping(path="/user-accounts/{accountUserId}") public VoidResponse deleteUserAccount(@PathVariable String accountUserId, @RequestParam(required=false) String delegatingUserId)
      Clear the account for a user with the platform security connector.
      Parameters:
      accountUserId - user id of the account
      delegatingUserId - external userId making request
      Returns:
      void response