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

Class ActorManagerResource

java.lang.Object

org.odpi.openmetadata.viewservices.actormanager.server.spring.ActorManagerResource

@RestController
@RequestMapping("/servers/{serverName}/api/open-metadata/{urlMarker}")
public class ActorManagerResource
extends Object

The ActorManagerResource provides part of the server-side implementation of the Actor Manager OMVS. =

Constructor Summary

Constructors

Constructor	Description
ActorManagerResource()	Default constructor

Method Summary

Modifier and Type	Method	Description
VoidResponse	addSecurityGroupMembership(String serverName, String urlMarker, String userIdentityGUID, NewClassificationRequestBody requestBody)	Add the SecurityGroupMembership classification to the user identity.
GUIDResponse	createActorProfile(String serverName, String urlMarker, NewElementRequestBody requestBody)	Create a actor profile.
GUIDResponse	createActorProfileFromTemplate(String serverName, String urlMarker, TemplateRequestBody requestBody)	Create a new metadata element to represent an actor profile using an existing metadata element as a template.
GUIDResponse	createActorRole(String serverName, String urlMarker, NewElementRequestBody requestBody)	Create a actor role.
GUIDResponse	createActorRoleFromTemplate(String serverName, String urlMarker, TemplateRequestBody requestBody)	Create a new metadata element to represent an actor role using an existing metadata element as a template.
GUIDResponse	createUserIdentity(String serverName, String urlMarker, NewElementRequestBody requestBody)	Create a user identity.
GUIDResponse	createUserIdentityFromTemplate(String serverName, String urlMarker, TemplateRequestBody requestBody)	Create a new metadata element to represent a user identity using an existing metadata element as a template.
VoidResponse	deleteActorProfile(String serverName, String urlMarker, String actorProfileGUID, DeleteRequestBody requestBody)	Delete a actor profile.
VoidResponse	deleteActorRole(String serverName, String urlMarker, String actorRoleGUID, DeleteRequestBody requestBody)	Delete a actor role.
VoidResponse	deleteUserIdentity(String serverName, String urlMarker, String userIdentityGUID, DeleteRequestBody requestBody)	Delete a user identity.
VoidResponse	detachAssetFromProfile(String serverName, String urlMarker, String assetGUID, String itProfileGUID, DeleteRequestBody requestBody)	Detach an asset from an IT profile.
VoidResponse	detachAssignmentScope(String serverName, String urlMarker, String scopeElementGUID, String actorGUID, DeleteRequestBody requestBody)	Detach an actor from the element that describes its scope.
VoidResponse	detachITProfileRoleFromProfile(String serverName, String urlMarker, String itProfileRoleGUID, String itProfileGUID, DeleteRequestBody requestBody)	Detach an IT profile role from an IT profile.
VoidResponse	detachPersonRoleFromProfile(String serverName, String urlMarker, String personRoleGUID, String personProfileGUID, DeleteRequestBody requestBody)	Detach a person role from a profile.
VoidResponse	detachProfileIdentity(String serverName, String urlMarker, String userIdentityGUID, String profileGUID, DeleteRequestBody requestBody)	Detach an actor profile from a user identity.
VoidResponse	detachTeamRoleFromProfile(String serverName, String urlMarker, String teamRoleGUID, String teamProfileGUID, DeleteRequestBody requestBody)	Detach a team role from a team profile.
OpenMetadataRootElementsResponse	findActorProfiles(String serverName, String urlMarker, SearchStringRequestBody requestBody)	Retrieve the list of actor profile metadata elements that contain the search string.
OpenMetadataRootElementsResponse	findActorRoles(String serverName, String urlMarker, SearchStringRequestBody requestBody)	Retrieve the list of actor role metadata elements that contain the search string.
OpenMetadataRootElementsResponse	findUserIdentities(String serverName, String urlMarker, SearchStringRequestBody requestBody)	Retrieve the list of user identity metadata elements that contain the search string.
OpenMetadataRootElementResponse	getActorProfileByGUID(String serverName, String urlMarker, String actorProfileGUID, GetRequestBody requestBody)	Return the properties of a specific actor profile.
OpenMetadataRootElementsResponse	getActorProfilesByName(String serverName, String urlMarker, FilterRequestBody requestBody)	Returns the list of actor profiles with a particular name.
OpenMetadataRootElementResponse	getActorRoleByGUID(String serverName, String urlMarker, String actorRoleGUID, GetRequestBody requestBody)	Return the properties of a specific actor role.
OpenMetadataRootElementsResponse	getActorRolesByName(String serverName, String urlMarker, FilterRequestBody requestBody)	Returns the list of actor roles with a particular name.
OpenMetadataRootElementsResponse	getUserIdentitiesByName(String serverName, String urlMarker, FilterRequestBody requestBody)	Returns the list of user identities with a particular name.
OpenMetadataRootElementResponse	getUserIdentityByGUID(String serverName, String urlMarker, String userIdentityGUID, GetRequestBody requestBody)	Return the properties of a specific user identity.
VoidResponse	linkAssetToProfile(String serverName, String urlMarker, String assetGUID, String itProfileGUID, NewRelationshipRequestBody requestBody)	Attach an asset to an IT profile.
VoidResponse	linkAssignmentScope(String serverName, String urlMarker, String scopeElementGUID, String actorGUID, NewRelationshipRequestBody requestBody)	Attach an actor to an element that describes its scope.
VoidResponse	linkIdentityToProfile(String serverName, String urlMarker, String userIdentityGUID, String profileGUID, NewRelationshipRequestBody requestBody)	Attach a profile to a user identity.
VoidResponse	linkITProfileRoleToProfile(String serverName, String urlMarker, String itProfileRoleGUID, String itProfileGUID, NewRelationshipRequestBody requestBody)	Attach an IT profile role to an IT profile.
VoidResponse	linkPersonRoleToProfile(String serverName, String urlMarker, String personRoleGUID, String personProfileGUID, NewRelationshipRequestBody requestBody)	Attach a person role to a person profile.
VoidResponse	linkTeamRoleToProfile(String serverName, String urlMarker, String teamRoleGUID, String teamProfileGUID, NewRelationshipRequestBody requestBody)	Attach a team role to a team profile.
VoidResponse	removeAllSecurityGroupMembership(String serverName, String urlMarker, String userIdentityGUID, MetadataSourceRequestBody requestBody)	Remove the SecurityGroupMembership classification from the user identity.
VoidResponse	updateActorProfile(String serverName, String urlMarker, String actorProfileGUID, UpdateElementRequestBody requestBody)	Update the properties of an actor profile.
VoidResponse	updateActorRole(String serverName, String urlMarker, String actorRoleGUID, UpdateElementRequestBody requestBody)	Update the properties of an actor role.
VoidResponse	updateSecurityGroupMembership(String serverName, String urlMarker, String userIdentityGUID, UpdateClassificationRequestBody requestBody)	Add the SecurityGroupMembership classification to the user identity.
VoidResponse	updateUserIdentity(String serverName, String urlMarker, String userIdentityGUID, UpdateElementRequestBody requestBody)	Update the properties of a user identity.

Methods inherited from class java.lang.Object

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

Constructor Details

ActorManagerResource

public ActorManagerResource()

Default constructor

Method Details

createActorProfile

@PostMapping(path="/actor-profiles")
public GUIDResponse createActorProfile(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @RequestBody(required=false)
 NewElementRequestBody requestBody)

Create a actor profile.

Parameters:

serverName - name of called server.

urlMarker - view service URL marker

requestBody - properties for the actor profile.

Returns:

unique identifier of the newly created element InvalidParameterException one of the parameters is invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

createActorProfileFromTemplate

@PostMapping(path="/actor-profiles/from-template")
public GUIDResponse createActorProfileFromTemplate(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @RequestBody(required=false)
 TemplateRequestBody requestBody)

Create a new metadata element to represent an actor profile using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new element.

Parameters:

serverName - calling user

urlMarker - view service URL marker

requestBody - properties that override the template

Returns:

unique identifier of the new metadata element InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

updateActorProfile

@PostMapping(path="/actor-profiles/{actorProfileGUID}/update")
public VoidResponse updateActorProfile(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String actorProfileGUID,
 @RequestBody(required=false)
 UpdateElementRequestBody requestBody)

Update the properties of an actor profile.

Parameters:

serverName - name of called server.

urlMarker - view service URL marker

actorProfileGUID - unique identifier of the actor profile (returned from create)

requestBody - properties for the new element.

Returns:

void or InvalidParameterException one of the parameters is invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

linkAssetToProfile

@PostMapping(path="/assets/{assetGUID}/it-profiles/{itProfileGUID}/attach")
public VoidResponse linkAssetToProfile(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String assetGUID,
 @PathVariable
 String itProfileGUID,
 @RequestBody(required=false)
 NewRelationshipRequestBody requestBody)

Attach an asset to an IT profile.

Parameters:

serverName - name of called server

urlMarker - view service URL marker

assetGUID - unique identifier of the asset

itProfileGUID - unique identifier of the IT profile

requestBody - description of the relationship.

Returns:

void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

detachAssetFromProfile

@PostMapping(path="/assets/{assetGUID}/it-profiles/{itProfileGUID}/detach")
public VoidResponse detachAssetFromProfile(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String assetGUID,
 @PathVariable
 String itProfileGUID,
 @RequestBody(required=false)
 DeleteRequestBody requestBody)

Detach an asset from an IT profile.

Parameters:

serverName - name of called server

urlMarker - view service URL marker

assetGUID - unique identifier of the asset

itProfileGUID - unique identifier of the IT profile

requestBody - description of the relationship.

Returns:

void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

deleteActorProfile

@PostMapping(path="/actor-profiles/{actorProfileGUID}/delete")
public VoidResponse deleteActorProfile(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String actorProfileGUID,
 @RequestBody(required=false)
 DeleteRequestBody requestBody)

Delete a actor profile.

Parameters:

serverName - name of called server

urlMarker - view service URL marker

actorProfileGUID - unique identifier of the element to delete

requestBody - description of the relationship.

Returns:

void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

getActorProfilesByName

@PostMapping(path="/actor-profiles/by-name")
public OpenMetadataRootElementsResponse getActorProfilesByName(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @RequestBody(required=false)
 FilterRequestBody requestBody)

Returns the list of actor profiles with a particular name.

Parameters:

serverName - name of the service to route the request to

urlMarker - view service URL marker

requestBody - string to find in the properties

Returns:

list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

findActorProfiles

@PostMapping(path="/actor-profiles/by-search-string")
public OpenMetadataRootElementsResponse findActorProfiles(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @RequestBody(required=false)
 SearchStringRequestBody requestBody)

Retrieve the list of actor profile metadata elements that contain the search string.

Parameters:

serverName - name of the service to route the request to

urlMarker - view service URL marker

requestBody - string to find in the properties

Returns:

list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

getActorProfileByGUID

@PostMapping(path="/actor-profiles/{actorProfileGUID}/retrieve")
public OpenMetadataRootElementResponse getActorProfileByGUID(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String actorProfileGUID,
 @RequestBody(required=false)
 GetRequestBody requestBody)

Return the properties of a specific actor profile.

Parameters:

serverName - name of the service to route the request to

urlMarker - view service URL marker

actorProfileGUID - unique identifier of the required element

requestBody - string to find in the properties

Returns:

list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

createActorRole

@PostMapping(path={"/actor-roles","/solution-roles"})
public GUIDResponse createActorRole(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @RequestBody(required=false)
 NewElementRequestBody requestBody)

Create a actor role.

Parameters:

serverName - name of called server.

urlMarker - view service URL marker

requestBody - properties for the actor role.

Returns:

unique identifier of the newly created element InvalidParameterException one of the parameters is invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

createActorRoleFromTemplate

@PostMapping(path={"/actor-roles/from-template","/solution-roles/from-template"})
public GUIDResponse createActorRoleFromTemplate(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @RequestBody(required=false)
 TemplateRequestBody requestBody)

Create a new metadata element to represent an actor role using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new element.

Parameters:

serverName - calling user

urlMarker - view service URL marker

requestBody - properties that override the template

Returns:

unique identifier of the new metadata element InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

updateActorRole

@PostMapping(path={"/actor-roles/{actorRoleGUID}/update","/solution-roles/{actorRoleGUID}/update"})
public VoidResponse updateActorRole(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String actorRoleGUID,
 @RequestBody(required=false)
 UpdateElementRequestBody requestBody)

Update the properties of an actor role.

Parameters:

serverName - name of called server.

urlMarker - view service URL marker

actorRoleGUID - unique identifier of the actor role (returned from create)

requestBody - properties for the new element.

Returns:

void or InvalidParameterException one of the parameters is invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

linkPersonRoleToProfile

@PostMapping(path="/actor-roles/{personRoleGUID}/person-role-appointments/{personProfileGUID}/attach")
public VoidResponse linkPersonRoleToProfile(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String personRoleGUID,
 @PathVariable
 String personProfileGUID,
 @RequestBody(required=false)
 NewRelationshipRequestBody requestBody)

Attach a person role to a person profile.

Parameters:

serverName - name of called server

urlMarker - view service URL marker

personRoleGUID - unique identifier of the person role

personProfileGUID - unique identifier of the person profile

requestBody - description of the relationship.

Returns:

void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

detachPersonRoleFromProfile

@PostMapping(path="/actor-roles/{personRoleGUID}/person-role-appointments/{personProfileGUID}/detach")
public VoidResponse detachPersonRoleFromProfile(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String personRoleGUID,
 @PathVariable
 String personProfileGUID,
 @RequestBody(required=false)
 DeleteRequestBody requestBody)

Detach a person role from a profile.

Parameters:

serverName - name of called server

urlMarker - view service URL marker

personRoleGUID - unique identifier of the person role

personProfileGUID - unique identifier of the person profile

requestBody - description of the relationship.

Returns:

void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

linkTeamRoleToProfile

@PostMapping(path="/actor-roles/{teamRoleGUID}/team-role-appointments/{teamProfileGUID}/attach")
public VoidResponse linkTeamRoleToProfile(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String teamRoleGUID,
 @PathVariable
 String teamProfileGUID,
 @RequestBody(required=false)
 NewRelationshipRequestBody requestBody)

Attach a team role to a team profile.

Parameters:

serverName - name of called server

urlMarker - view service URL marker

teamRoleGUID - unique identifier of the team role

teamProfileGUID - unique identifier of the team profile

requestBody - description of the relationship.

Returns:

void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

detachTeamRoleFromProfile

@PostMapping(path="/actor-roles/{teamRoleGUID}/team-role-appointments/{teamProfileGUID}/detach")
public VoidResponse detachTeamRoleFromProfile(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String teamRoleGUID,
 @PathVariable
 String teamProfileGUID,
 @RequestBody(required=false)
 DeleteRequestBody requestBody)

Detach a team role from a team profile.

Parameters:

serverName - name of called server

urlMarker - view service URL marker

teamRoleGUID - unique identifier of the team role

teamProfileGUID - unique identifier of the team profile

requestBody - description of the relationship.

Returns:

void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

linkITProfileRoleToProfile

@PostMapping(path="/actor-roles/{itProfileRoleGUID}/it-profile-role-appointments/{itProfileGUID}/attach")
public VoidResponse linkITProfileRoleToProfile(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String itProfileRoleGUID,
 @PathVariable
 String itProfileGUID,
 @RequestBody(required=false)
 NewRelationshipRequestBody requestBody)

Attach an IT profile role to an IT profile.

Parameters:

serverName - name of called server

urlMarker - view service URL marker

itProfileRoleGUID - unique identifier of the IT profile role

itProfileGUID - unique identifier of the IT profile

requestBody - description of the relationship.

Returns:

void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

detachITProfileRoleFromProfile

@PostMapping(path="/actor-roles/{itProfileRoleGUID}/it-profile-role-appointments/{itProfileGUID}/detach")
public VoidResponse detachITProfileRoleFromProfile(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String itProfileRoleGUID,
 @PathVariable
 String itProfileGUID,
 @RequestBody(required=false)
 DeleteRequestBody requestBody)

Detach an IT profile role from an IT profile.

Parameters:

serverName - name of called server

urlMarker - view service URL marker

itProfileRoleGUID - unique identifier of the IT profile role

itProfileGUID - unique identifier of the IT profile

requestBody - description of the relationship.

Returns:

void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

deleteActorRole

@PostMapping(path={"/actor-roles/{actorRoleGUID}/delete","/solution-roles/{actorRoleGUID}/delete"})
public VoidResponse deleteActorRole(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String actorRoleGUID,
 @RequestBody(required=false)
 DeleteRequestBody requestBody)

Delete a actor role.

Parameters:

serverName - name of called server

urlMarker - view service URL marker

actorRoleGUID - unique identifier of the element to delete

requestBody - description of the relationship.

Returns:

void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

getActorRolesByName

@PostMapping(path={"/actor-roles/by-name","/solution-roles/by-name"})
public OpenMetadataRootElementsResponse getActorRolesByName(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @RequestBody(required=false)
 FilterRequestBody requestBody)

Returns the list of actor roles with a particular name.

Parameters:

serverName - name of the service to route the request to

urlMarker - view service URL marker

requestBody - string to find in the properties

Returns:

list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

findActorRoles

@PostMapping(path={"/actor-roles/by-search-string","/solution-roles/by-search-string"})
public OpenMetadataRootElementsResponse findActorRoles(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @RequestBody(required=false)
 SearchStringRequestBody requestBody)

Retrieve the list of actor role metadata elements that contain the search string.

Parameters:

serverName - name of the service to route the request to

urlMarker - view service URL marker

requestBody - string to find in the properties

Returns:

list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

getActorRoleByGUID

@PostMapping(path={"/actor-roles/{actorRoleGUID}/retrieve","/solution-roles/{actorRoleGUID}/retrieve"})
public OpenMetadataRootElementResponse getActorRoleByGUID(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String actorRoleGUID,
 @RequestBody(required=false)
 GetRequestBody requestBody)

Return the properties of a specific actor role.

Parameters:

serverName - name of the service to route the request to

urlMarker - view service URL marker

actorRoleGUID - unique identifier of the required element

requestBody - string to find in the properties

Returns:

list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

createUserIdentity

@PostMapping(path="/user-identities")
public GUIDResponse createUserIdentity(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @RequestBody(required=false)
 NewElementRequestBody requestBody)

Create a user identity.

Parameters:

serverName - name of called server.

urlMarker - view service URL marker

requestBody - properties for the user identity.

Returns:

unique identifier of the newly created element InvalidParameterException one of the parameters is invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

createUserIdentityFromTemplate

@PostMapping(path="/user-identities/from-template")
public GUIDResponse createUserIdentityFromTemplate(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @RequestBody(required=false)
 TemplateRequestBody requestBody)

Create a new metadata element to represent a user identity using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new element.

Parameters:

serverName - calling user

urlMarker - view service URL marker

requestBody - properties that override the template

Returns:

unique identifier of the new metadata element InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

updateUserIdentity

@PostMapping(path="/user-identities/{userIdentityGUID}/update")
public VoidResponse updateUserIdentity(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String userIdentityGUID,
 @RequestBody(required=false)
 UpdateElementRequestBody requestBody)

Update the properties of a user identity.

Parameters:

serverName - name of called server.

urlMarker - view service URL marker

userIdentityGUID - unique identifier of the user identity (returned from create)

requestBody - properties for the new element.

Returns:

void or InvalidParameterException one of the parameters is invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

linkIdentityToProfile

@PostMapping(path="/user-identities/{userIdentityGUID}/profile-identity/{profileGUID}/attach")
public VoidResponse linkIdentityToProfile(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String userIdentityGUID,
 @PathVariable
 String profileGUID,
 @RequestBody(required=false)
 NewRelationshipRequestBody requestBody)

Attach a profile to a user identity.

Parameters:

serverName - name of called server

urlMarker - view service URL marker

userIdentityGUID - unique identifier of the user identity

profileGUID - unique identifier of the actor profile

requestBody - description of the relationship.

Returns:

void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

detachProfileIdentity

@PostMapping(path="/user-identities/{userIdentityGUID}/profile-identity/{profileGUID}/detach")
public VoidResponse detachProfileIdentity(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String userIdentityGUID,
 @PathVariable
 String profileGUID,
 @RequestBody(required=false)
 DeleteRequestBody requestBody)

Detach an actor profile from a user identity.

Parameters:

serverName - name of called server

urlMarker - view service URL marker

userIdentityGUID - unique identifier of the user identity

profileGUID - unique identifier of the actor profile

requestBody - description of the relationship.

Returns:

void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

addSecurityGroupMembership

@PostMapping(path="/user-identities/{userIdentityGUID}/security-group-memberships/classify")
public VoidResponse addSecurityGroupMembership(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String userIdentityGUID,
 @RequestBody(required=false)
 NewClassificationRequestBody requestBody)

Add the SecurityGroupMembership classification to the user identity.

Parameters:

serverName - name of called server

urlMarker - view service URL marker

userIdentityGUID - unique identifier of the user identity

requestBody - description of the relationship.

Returns:

void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

updateSecurityGroupMembership

@PostMapping(path="/user-identities/{userIdentityGUID}/security-group-memberships/reclassify")
public VoidResponse updateSecurityGroupMembership(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String userIdentityGUID,
 @RequestBody(required=false)
 UpdateClassificationRequestBody requestBody)

Add the SecurityGroupMembership classification to the user identity.

Parameters:

serverName - name of called server

urlMarker - view service URL marker

userIdentityGUID - unique identifier of the user identity

requestBody - description of the relationship.

Returns:

void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

removeAllSecurityGroupMembership

@PostMapping(path="/user-identities/{userIdentityGUID}/security-group-memberships/declassify")
public VoidResponse removeAllSecurityGroupMembership(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String userIdentityGUID,
 @RequestBody(required=false)
 MetadataSourceRequestBody requestBody)

Remove the SecurityGroupMembership classification from the user identity.

Parameters:

serverName - name of called server

urlMarker - view service URL marker

userIdentityGUID - unique identifier of the user identity

requestBody - description of the relationship.

Returns:

void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

deleteUserIdentity

@PostMapping(path="/user-identities/{userIdentityGUID}/delete")
public VoidResponse deleteUserIdentity(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String userIdentityGUID,
 @RequestBody(required=false)
 DeleteRequestBody requestBody)

Delete a user identity.

Parameters:

serverName - name of called server

urlMarker - view service URL marker

userIdentityGUID - unique identifier of the element to delete

requestBody - description of the relationship.

Returns:

void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

getUserIdentitiesByName

@PostMapping(path="/user-identities/by-name")
public OpenMetadataRootElementsResponse getUserIdentitiesByName(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @RequestBody(required=false)
 FilterRequestBody requestBody)

Returns the list of user identities with a particular name.

Parameters:

serverName - name of the service to route the request to

urlMarker - view service URL marker

requestBody - string to find in the properties

Returns:

list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

findUserIdentities

@PostMapping(path="/user-identities/by-search-string")
public OpenMetadataRootElementsResponse findUserIdentities(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @RequestBody(required=false)
 SearchStringRequestBody requestBody)

Retrieve the list of user identity metadata elements that contain the search string.

Parameters:

serverName - name of the service to route the request to

urlMarker - view service URL marker

requestBody - string to find in the properties

Returns:

list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

getUserIdentityByGUID

@PostMapping(path="/user-identities/{userIdentityGUID}/retrieve")
public OpenMetadataRootElementResponse getUserIdentityByGUID(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String userIdentityGUID,
 @RequestBody(required=false)
 GetRequestBody requestBody)

Return the properties of a specific user identity.

Parameters:

serverName - name of the service to route the request to

urlMarker - view service URL marker

userIdentityGUID - unique identifier of the required element

requestBody - string to find in the properties

Returns:

list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

linkAssignmentScope

@PostMapping(path="/elements/{scopeElementGUID}/actors/{actorGUID}/attach")
public VoidResponse linkAssignmentScope(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String scopeElementGUID,
 @PathVariable
 String actorGUID,
 @RequestBody(required=false)
 NewRelationshipRequestBody requestBody)

Attach an actor to an element that describes its scope.

Parameters:

serverName - name of called server

urlMarker - view service URL marker

scopeElementGUID - unique identifier of the element

actorGUID - unique identifier of the actor

requestBody - description of the relationship.

Returns:

void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

detachAssignmentScope

@PostMapping(path="/elements/{scopeElementGUID}/actors/{actorGUID}/detach")
public VoidResponse detachAssignmentScope(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String scopeElementGUID,
 @PathVariable
 String actorGUID,
 @RequestBody(required=false)
 DeleteRequestBody requestBody)

Detach an actor from the element that describes its scope.

Parameters:

serverName - name of called server

urlMarker - view service URL marker

scopeElementGUID - unique identifier of the element

actorGUID - unique identifier of the actor

requestBody - description of the relationship.

Returns:

void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.