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 Summary

Constructors

Constructor	Description
OMAGServerPlatformSecurityResource()

Method Summary

Modifier and Type	Method	Description
VoidResponse	clearPlatformSecurityConnection(String delegatingUserId)	Clear the connection object for platform security.
ConnectionResponse	getPlatformSecurityConnection(String delegatingUserId)	Return the connection object for platform metadata security connector.
VoidResponse	setPlatformSecurityConnection(String delegatingUserId, PlatformSecurityRequestBody requestBody)	Set up a platform metadata security connector

Methods inherited from class java.lang.Object

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

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