Package org.odpi.openmetadata.adminservices.spring

Class ConfigOpenMetadataPlatformSecurityResource

java.lang.Object

org.odpi.openmetadata.adminservices.spring.ConfigOpenMetadataPlatformSecurityResource

@RestController
@RequestMapping("/open-metadata/admin-services/users/{userId}/platform/security")
public class ConfigOpenMetadataPlatformSecurityResource
extends Object

ConfigOpenMetadataPlatformSecurityResource 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
ConfigOpenMetadataPlatformSecurityResource()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigOpenMetadataPlatformSecurityResource

public ConfigOpenMetadataPlatformSecurityResource()

Method Detail

setPlatformSecurityConnection

@PostMapping(path="/connection")
public VoidResponse setPlatformSecurityConnection(@PathVariable
                                                  String userId,
                                                  @RequestBody
                                                  PlatformSecurityRequestBody requestBody)

Set up a platform 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 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