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

Class SecurityOfficerResource

java.lang.Object

org.odpi.openmetadata.viewservices.securityofficer.server.spring.SecurityOfficerResource

@RestController
@RequestMapping("/servers/{serverName}/api/open-metadata/security-officer")
public class SecurityOfficerResource
extends Object

The SecurityOfficerResource provides part of the server-side implementation of the Security Officer OMVS. =

Constructor Summary

Constructors

Constructor	Description
SecurityOfficerResource()	Default constructor

Method Summary

Modifier and Type	Method	Description
VoidResponse	deleteSecurityAccessControl(String serverName, String platformGUID, String controlName)	Clear the named security access control with the platform security connector.
VoidResponse	deleteUserAccount(String serverName, String platformGUID, String accountUserId)	Clear the account for a user with the platform security connector.
VoidResponse	detachGovernanceZones(String serverName, String governanceZoneGUID, String nestedGovernanceZoneGUID, DeleteRelationshipRequestBody requestBody)	Detach a governance zone definition from a hierarchical relationship.
SecurityAccessControlResponse	getSecurityAccessControl(String serverName, String platformGUID, String controlName)	Return the security access control object from the platform metadata security connector.
UserAccountResponse	getUserAccount(String serverName, String platformGUID, String accountUserId)	Return the user account object for the requested user from the platform metadata security connector.
VoidResponse	linkGovernanceZones(String serverName, String governanceZoneGUID, String nestedGovernanceZoneGUID, NewRelationshipRequestBody requestBody)	Attach a nested governance zone to a broader governance zone definition.
VoidResponse	setSecurityAccessControl(String serverName, String platformGUID, SecurityAccessControlRequestBody requestBody)	Set up or update a security access control in the platform metadata security connector.
VoidResponse	setUserAccount(String serverName, String platformGUID, UserAccountRequestBody requestBody)	Set up or update a user account in the platform metadata security connector.

Methods inherited from class java.lang.Object

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

Constructor Details

SecurityOfficerResource

public SecurityOfficerResource()

Default constructor

Method Details

setUserAccount

@PostMapping(path="/platforms/{platformGUID}/user-accounts")
public VoidResponse setUserAccount(@PathVariable
 String serverName,
 @PathVariable
 String platformGUID,
 @RequestBody(required=false)
 UserAccountRequestBody requestBody)

Set up or update a user account in the platform metadata security connector. The user requires operator permission for the platform unless it is their own user account they are retrieving.

Parameters:

serverName - name of called server

platformGUID - unique identifier of the platform

requestBody - requestBody used to create and configure the connector that performs platform security

Returns:

void response

getUserAccount

@GetMapping(path="/platforms/{platformGUID}/user-accounts/{accountUserId}")
public UserAccountResponse getUserAccount(@PathVariable
 String serverName,
 @PathVariable
 String platformGUID,
 @PathVariable
 String accountUserId)

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. The user requires operator permission for the platform unless it is their own user account they are retrieving.

Parameters:

serverName - name of called server

platformGUID - unique identifier of the platform

accountUserId - user id of the account

Returns:

user account response

deleteUserAccount

@DeleteMapping(path="/platforms/{platformGUID}/user-accounts/{accountUserId}")
public VoidResponse deleteUserAccount(@PathVariable
 String serverName,
 @PathVariable
 String platformGUID,
 @PathVariable
 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 - user id of the account

Returns:

void response

setSecurityAccessControl

@PostMapping(path="/platforms/{platformGUID}/security-access-control")
public VoidResponse setSecurityAccessControl(@PathVariable
 String serverName,
 @PathVariable
 String platformGUID,
 @RequestBody(required=false)
 SecurityAccessControlRequestBody requestBody)

Set up or update a security access control in the platform metadata security connector. The user requires operator permission for the platform.

Parameters:

serverName - name of called server

platformGUID - unique identifier of the platform

requestBody - requestBody used to create and configure the connector that performs platform security

Returns:

void response

getSecurityAccessControl

@GetMapping(path="/platforms/{platformGUID}/security-access-control/{controlName}")
public SecurityAccessControlResponse getSecurityAccessControl(@PathVariable
 String serverName,
 @PathVariable
 String platformGUID,
 @PathVariable
 String controlName)

Return the security access control object from the platform metadata security connector. Null is returned if no control has been set up. The user requires operator permission for the platform.

Parameters:

serverName - name of called server

platformGUID - unique identifier of the platform

controlName - name of the control

Returns:

user account response

deleteSecurityAccessControl

@DeleteMapping(path="/platforms/{platformGUID}/security-access-control/{controlName}")
public VoidResponse deleteSecurityAccessControl(@PathVariable
 String serverName,
 @PathVariable
 String platformGUID,
 @PathVariable
 String controlName)

Clear the named security access control with the platform security connector.

Parameters:

serverName - name of called server

platformGUID - unique identifier of the platform

controlName - name of the control

Returns:

void response

linkGovernanceZones

@PostMapping(path="/governance-zones/{governanceZoneGUID}/governance-zone-hierarchies/{nestedGovernanceZoneGUID}/attach")
public VoidResponse linkGovernanceZones(@PathVariable
 String serverName,
 @PathVariable
 String governanceZoneGUID,
 @PathVariable
 String nestedGovernanceZoneGUID,
 @RequestBody(required=false)
 NewRelationshipRequestBody requestBody)

Attach a nested governance zone to a broader governance zone definition.

Parameters:

serverName - name of called server

governanceZoneGUID - unique identifier of the first governance zone definition

nestedGovernanceZoneGUID - unique identifier of the second governance zone definition

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

@PostMapping(path="/governance-zones/{governanceZoneGUID}/governance-zone-hierarchies/{nestedGovernanceZoneGUID}/detach")
public VoidResponse detachGovernanceZones(@PathVariable
 String serverName,
 @PathVariable
 String governanceZoneGUID,
 @PathVariable
 String nestedGovernanceZoneGUID,
 @RequestBody(required=false)
 DeleteRelationshipRequestBody requestBody)

Detach a governance zone definition from a hierarchical relationship.

Parameters:

serverName - name of called server

governanceZoneGUID - unique identifier of the first governance zone definition

nestedGovernanceZoneGUID - unique identifier of the second governance zone definition

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.