RoleManager (Oracle Fusion Middleware Java API Reference for Oracle Identity Manager)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

oracle.iam.identity.rolemgmt.api
Interface RoleManager

public interface RoleManager

The RoleManager API exposes the methods to manage Roles.

The Role VO can be prepared for Create Role APIs as follows -
Use it with following APIs
create(Role)
createRequest(Role)

Role role = new Role();

To populate Catalog into the Role
Catalog catalogAttributes = new Catalog();
catalogAttributes.setCertifiable(true);
role.setAttribute(RoleManagerConstants.CATALOG_ATTRIBUTES, catalogAttributes);

To add one or more parent roles
List<String> roleParents = new ArrayList<String>();
roleParents.add(roleParentKey1);
roleParents.add(roleParentKey2);
role.setAttribute(RoleManagerConstants.ROLE_PARENTS, roleParents);

To add static user memberships
listOfMembers = new ArrayList<RoleGrant>();
RoleGrant member = new RoleGrant(null, userKey);
Calendar c = Calendar.getInstance();
c.add(Calendar.DAY_OF_MONTH, 15);
Date startDate1 = c.getTime();
c.add(Calendar.DAY_OF_MONTH, 25);
Date endDate1 = c.getTime();
member.setAttribute(RoleManagerConstants.ROLE_GRANT_START_DATE, startDate1);
member.setAttribute(RoleManagerConstants.ROLE_GRANT_END_DATE, endDate1);
listOfMembers.add(member);
role.setAttribute(RoleManagerConstants.ROLE_MEMBERSHIPS, listOfMembers);
start/end date can be null. Any future start date will result in a pending grant which will happen when the start date arrives.

To add access policies for the role
List<String> accessPolicies = new ArrayList<String>();
accessPolicies.add(accessPolicyKey1);
accessPolicies.add(accessPolicyKey2);
role.setAttribute(RoleManagerConstants.ACCESS_POLICIES, accessPolicies);

To add organizations, you must create EntityPublication objects
List<EntityPublication> entityPubs = new ArrayList<EntityPublication>();
entityPubs.add(new EntityPublication(null, PolicyConstants.Resources.ROLE, Long.valueOf(orgKey1), true)) ;
entityPubs.add(new EntityPublication(null, PolicyConstants.Resources.ROLE, Long.valueOf(orgKey2), true)) ;
role.setAttribute(RoleManagerConstants.ORGANIZATIONS_PUBLISHED_TO, entityPubs);
For role create, the roleKey will be null in EntityPublication. During role modify, the role key must be passed.

To pass a user membership rule
SearchRule searchRule = new SearchRule(UserManagerConstants.AttributeName.LASTNAME.getId(), "saini", SearchRule.Operator.EQUAL);
role.setAttribute(RoleManagerConstants.ROLE_USER_MEMBERSHIP_RULE.getId(), userMembershipRule);

The Role VO can be prepared for Modify Role APIs similarly to Create Role, except for the following differences -
Use it with following APIs
modify(Role)
modify(Set, Role)
modify(String, Object, Role)
modifyRequest(Role)
modifyRequest(Set, Role)
modifyRequest(String, Object, Role)

To modify catalog details
CatalogService catalogService = getService(CatalogService.class);
Catalog catalogAttributes = catalogService.getCatalogItemDetails(null, roleKey, OIMType.Role, null);
// Modify the catalog VO as required catalogAttributes.setApproverUser("5");
catalogAttributes.setCertifiable(true);
attributes.put(RoleManagerConstants.CATALOG_ATTRIBUTES, catalogAttributes);

To update the organizations published to
//To delete existing publication, it must first be fetched
oracle.iam.platformservice.api.EntityPublicationService entityPubService = getService(oracle.iam.platformservice.api.EntityPublicationService.class);
List<EntityPublication> entityPubsAssigned = entityPubService.listEntityPublications(PolicyConstants.Resources.ROLE, roleKey, null);

Map<String, List<EntityPublication>> entityPubsMap = new HashMap<String, List<EntityPublication>>();
List<EntityPublication> entityPubsAddList = new ArrayList<EntityPublication> ();
List<EntityPublication> entityPubsUpdateList = new ArrayList<EntityPublication> ();
List<EntityPublication> entityPubsDeleteList = new ArrayList<EntityPublication> ();
entityPubsAddList.add(new EntityPublication(roleKey, PolicyConstants.Resources.ROLE, Long.valueOf(orgKey3), true));
entityPubsUpdateList.add(entityPubsAssigned.get(2));
entityPubsDeleteList.add(entityPubsAssigned.get(0));
entityPubsMap.put("ADD", entityPubsAddList);
entityPubsMap.put("UPDATE", entityPubsUpdateList);
entityPubsMap.put("DELETE", entityPubsDeleteList);

attributes.put(RoleManagerConstants.ORGANIZATIONS_PUBLISHED_TO,entityPubsMap);
UPDATE and DELETE must have entity publications fetched from backend with publicationID populated
To update parent roles. You can add Parents roles & remove existing parent roles .
Map<String, List<String>> roleParentsUpdate = new HashMap<String, List<String>> ();
List<String> deleteRoleParents = new ArrayList<String>();
deleteRoleParents.add(role1);
deleteRoleParents.add(role2);
List<String> addRoleParents = new ArrayList<String>();
addRoleParents.add(role3);
roleParentsUpdate.put(RoleManagerConstants.ADD, addRoleParents);
roleParentsUpdate.put(RoleManagerConstants.DELETE, deleteRoleParents);
role.setAttribute(RoleManagerConstants.ROLE_PARENTS, roleParentsUpdate);

To update static user memberships
addListOfMembers = new ArrayList<RoleGrant>();
updateListOfMembers = new ArrayList<RoleGrant>();
deleteListOfMembers = new ArrayList<RoleGrant>();
RoleGrant member = new RoleGrant(null, userKey);
Calendar c = Calendar.getInstance();
c.add(Calendar.DAY_OF_MONTH, 15);
Date startDate1 = c.getTime();
c.add(Calendar.DAY_OF_MONTH, 25);
Date endDate1 = c.getTime();
member.setAttribute(RoleManagerConstants.ROLE_GRANT_START_DATE, startDate1);
member.setAttribute(RoleManagerConstants.ROLE_GRANT_END_DATE, endDate1);
addListOfMembers.add(member);

Similarly prepare the updateListOfMembers and deleteListOfMembers. RoleGrant member = new RoleGrant(null, userKey);
updateListOfMembers.add(member);
RoleGrant member = new RoleGrant(null, userKey);
deleteListOfMembers.add(member);
Map<String, List<RoleGrant>> userMemberships = new HashMap<String, List<RoleGrant>>();
userMemberships.put(RoleManagerConstants.ADD, addListOfMembers);
userMemberships.put(RoleManagerConstants.UPDATE, updateListOfMembers);
userMemberships.put(RoleManagerConstants.DELETE, deleteListOfMembers);
role.setAttribute(RoleManagerConstants.ROLE_MEMBERSHIPS, userMemberships);
start/end date can be null. Any future start date will result in a pending grant which will happen when the start date arrives.

To update the access policies for the role
Map<String, List<String>> accessPoliciesMap = new HashMap<String, List<String>>();
List<String> accessPoliciesAddList = new ArrayList<String>();
List<String> accessPoliciesDeleteList = new ArrayList<String>();

accessPoliciesAddList.add(accessPolicy3);
accessPoliciesDeleteList.add(accessPolicy2);
accessPoliciesMap.put("ADD", accessPoliciesAddList);
accessPoliciesMap.put("DELETE", accessPoliciesDeleteList);

attributes.put(RoleManagerConstants.ACCESS_POLICIES, accessPoliciesMap);

To get all the details of the role, use the following APIs
getDetails(String, Object, Set)
getDetails(String, Set)
getDirectRoleParents(String, Set, Map)
getRoleParents(String, boolean)

Method Summary
`RoleManagerResult`	`addRoleRelationship(java.lang.String parentAttrName, java.lang.Object parentAttrValue, java.lang.String childAttrName, java.lang.Object childAttrValue)` Add a direct relationship between two roles, where the parent role is uniquely identified by the search criteria `parentAttrName=parentAttrValue` and the child role is uniquely identified by the search criteria `childAttrName=childAttrValue`.
`RoleManagerResult`	`addRoleRelationship(java.lang.String roleParentKey, java.lang.String roleChildKey)` Add a direct relationship between two roles.
`RoleManagerResult`	`create(Role role)` This method creates a role.
`java.lang.String`	`createRequest(Role role)` This method raises a request to create the role in the back end data store
`RoleManagerResult`	`delete(java.util.Set roleKeys)` Bulk delete operation.
`RoleManagerResult`	`delete(java.lang.String roleKey)` Delete the role.
`RoleManagerResult`	`delete(java.lang.String attributeName, java.lang.Object attributeValue)` This method deletes a role based on the search criteria `attributeName=attributeValue`.
`java.lang.String`	`deleteRequest(java.util.Set roleKeys)` Raises a request to delete all the specified roles.
`java.lang.String`	`deleteRequest(java.lang.String roleKey)` Raises a request to delete the role.
`java.lang.String`	`deleteRequest(java.lang.String attributeName, java.lang.Object attributeValue)` This method raises a request to delete a role based on the search criteria `attributeName=attributeValue`.
`Role`	`getDetails(java.lang.String attributeName, java.lang.Object attributeValue, java.util.Set retAttrs)` This method return the role details for a role based on the search criteria `attributeName=attributeValue`.
`Role`	`getDetails(java.lang.String roleKey, java.util.Set retAttrs)` Returns the profile details of the specified role.
`Role`	`getDetails(java.lang.String roleKey, java.util.Set retAttrs, OperationContext opContext)` Returns the profile details of the specified role.
`java.util.List`	`getDirectRoleChildren(java.lang.String roleParentKey, java.util.Set retAttrs, java.util.Map configParams)` Retrieve the roles direct children of the given role.
`java.util.List`	`getDirectRoleParents(java.lang.String roleChildKey, java.util.Set retAttrs, java.util.Map configParams)` Retrieve the roles who are the direct parents of the given role.
`java.util.List`	`getDynamicRoleMembers(java.lang.String roleKey)` Retrieve all the dynamic users members of the given role.
`java.util.List`	`getDynamicRoleMembers(java.lang.String roleKey, java.util.Set retAttrs, java.util.Map configParams)` Retrieve all the dynamic users members of the given role.
`java.util.List`	`getPendingRoleGrants(java.lang.String roleKey, java.util.Set retAttrs, java.util.Map configParams)` Retrieve the pending role grants of the given role.
`Relationship`	`getPendingRoleUserRelationshipAttributes(java.lang.String roleKey, java.lang.String userKey, java.util.Set retAttrs)` Lookup the attributes of a pending role grant.
`java.util.List`	`getPendingUserGrants(java.lang.String userKey, java.util.Set retAttrs, java.util.Map configParams)` Retrieve the pending role grants of the given user.
`java.util.List`	`getRoleChildren(java.lang.String roleParentKey, boolean directAndIndirect)` Retrieve the roles children of the given role.
`Relationship`	`getRoleGrantDetails(java.lang.String roleAttributeName, java.lang.Object roleAttributeValue, java.lang.String userAttributeName, java.lang.Object userAttributeValue, java.util.Set retAttrs)` Lookup the attributes of a role grant, where the role is identified uniquely by the search criteria `roleAttributeName=roleAttributeValue` and the user is uniquely identified by the search criteria `userAttributeName=userAttributeValue`.
`Relationship`	`getRoleGrantDetails(java.lang.String roleKey, java.lang.String userKey, java.util.Set retAttrs)` Lookup the attributes of a role grant, associated between `roleKey` and `userKey`.
`java.util.List`	`getRoleIndirectMembers(java.lang.String roleKey, SearchCriteria criteria, java.util.Set retAttrs, java.util.Map configParams)` Retrieve the indirect members (users) of the given role matching the specified `SearchCriteria`.
`java.util.List`	`getRoleMembers(java.lang.String roleKey, boolean directAndIndirect)` Retrieve all the users members of the given role.
`java.util.List`	`getRoleMembers(java.lang.String roleKey, SearchCriteria criteria, java.util.Set retAttrs, java.util.Map configParams, boolean directAndIndirect)` Retrieve the users members of the given role matching the specified `SearchCriteria`.
`java.util.List`	`getRoleParents(java.lang.String roleChildKey, boolean directAndIndirect)` Retrieve the roles who are the parents of the given role.
`Relationship`	`getRoleRelationshipDetails(java.lang.String parentAttrName, java.lang.Object parentAttrValue, java.lang.String childAttrName, java.lang.Object childAttrValue, java.util.Set retAttrs)` Lookup the attributes of a role relationship, where the parent role is uniquely identified by the search criteria `parentAttrName=parentAttrValue` and the child role is uniquely identified by the search criteria `childAttrName=childAttrValue`.
`Relationship`	`getRoleRelationshipDetails(java.lang.String roleParentKey, java.lang.String roleChildKey, java.util.Set retAttrs)` Lookup the attributes of a role relationship.
`java.util.List`	`getSimilarRoles(Role role)` Finds similar roles based on entitlements.
`java.util.List`	`getUnassignedRoleMembers(java.lang.String roleKey)` Retrieve all the users that are not direct members of the given role.
`java.util.List`	`getUnassignedRoleMembers(java.lang.String roleKey, SearchCriteria criteria, java.util.Set retAttrs, java.util.Map configParams)` Retrieve all the users that are not direct members of the given role matching the specified `SearchCriteria`.
`java.util.List`	`getUnassignedUserMemberships(java.lang.String userKey, SearchCriteria criteria, java.util.Set retAttrs, java.util.Map configParams)` Retrieve all the roles that are not direct memberships of the given user matching the specified `SearchCriteria`.
`SearchRule`	`getUserMembershipRule(java.lang.String roleKey)` Returns the user membership rule for the specified Role
`java.util.List`	`getUserMemberships(java.lang.String userKey, boolean directAndIndirect)` Retrieve all the roles that the user is a member of.
`java.util.List`	`getUserMemberships(java.lang.String userKey, SearchCriteria criteria, java.util.Set retAttrs, java.util.Map configParams, boolean directAndIndirect)` Retrieve the roles of the given user matching the specified `SearchCriteria`.
`java.util.List`	`getUserRoleGrants(java.lang.String userKey, SearchCriteria criteria, java.util.Map configParams, boolean directAndIndirect, java.util.Set roleGrantRetAttrs, java.util.Set roleRetAttrs, java.util.Set userRetAttrs)` Retrieve the role grants of the given user matching the specified `SearchCriteria`.
`RoleManagerResult`	`grantRole(java.lang.String roleKey, java.util.List userKeys, java.util.List relationshipAttrs)` Grant the role identified by roleKey to the specified user/s.
`RoleManagerResult`	`grantRole(java.lang.String roleAttributeName, java.lang.Object roleAttributeValue, java.lang.String userAttributeName, java.lang.Object userAttributeValue)` Grant the role(s) are identified by the search criteria `roleAttributeName=roleAttributeValue` to the specified user(s) identified by the search criteria `userAttributeName=userAttributeValue`.
`RoleManagerResult`	`grantRole(java.lang.String roleAttributeName, java.lang.Object roleAttributeValue, java.lang.String userAttributeName, java.lang.Object userAttributeValue, java.util.Map relationshipAttrs)` Grant the role uniquely identified by the search criteria `roleAttributeName=roleAttributeValue` to the specified user uniquely identified by the search criteria `userAttributeName=userAttributeValue`.
`RoleManagerResult`	`grantRole(java.lang.String roleKey, java.util.Set userKeys)` Grant the role identified by `roleKey` to the specified user(s).
`RoleManagerResult`	`grantRole(java.lang.String roleKey, java.util.Set userKeys, boolean evaluatePolicies)` Deprecated.
`RoleManagerResult`	`grantRole(java.lang.String roleKey, java.util.Set userKeys, java.util.Map relationshipAttrs)` Grant the role identified by roleKey to the specified user/s.
`RoleManagerResult`	`grantRole(java.lang.String roleKey, java.util.Set userKeys, java.util.Map relationshipAttrs, boolean evaluatePolicies)` Grant the role identified by roleKey to the specified user/s.
`java.lang.String`	`grantRoleRequest(java.lang.String roleKey, java.util.List userKeys, java.util.List relationshipAttrs)` Raises a request to grant the role identified by roleKey to the specified user/s.
`java.lang.String`	`grantRoleRequest(java.lang.String roleAttributeName, java.lang.Object roleAttributeValue, java.lang.String userAttributeName, java.lang.Object userAttributeValue)` Raises a request to grant the role(s) are identified by the search criteria `roleAttributeName=roleAttributeValue` to the specified user(s) identified by the search criteria `userAttributeName=userAttributeValue`.
`java.lang.String`	`grantRoleRequest(java.lang.String roleAttributeName, java.lang.Object roleAttributeValue, java.lang.String userAttributeName, java.lang.Object userAttributeValue, java.util.Map relationshipAttrs)` Raises a request to grant the role uniquely identified by the search criteria `roleAttributeName=roleAttributeValue` to the specified user uniquely identified by the search criteria `userAttributeName=userAttributeValue`.
`java.lang.String`	`grantRoleRequest(java.lang.String roleKey, java.util.Set userKeys)` Raises a request to grant the role identified by `roleKey` to the specified user/s.
`java.lang.String`	`grantRoleRequest(java.lang.String roleKey, java.util.Set userKeys, java.util.Map relationshipAttrs)` Raises a request to grant the role identified by roleKey to the specified user/s.
`RoleManagerResult`	`grantRoles(java.lang.String userKey, java.util.Set roleKeys)` Grant the roles identified by `roleKeys` to the user identified by `userKey`.
`RoleManagerResult`	`grantRoles(java.lang.String userKey, java.util.Set roleKeys, java.util.Map relationshipAttrs)` Grant the roles identified by roleKeys to the specified user.
`java.lang.String`	`grantRolesRequest(java.lang.String userKey, java.util.Set roleKeys)` Raises a request to grant the roles identified by `roleKeys` to the user identified by `userKey`.
`java.lang.String`	`grantRolesRequest(java.lang.String userKey, java.util.Set roleKeys, java.util.Map relationshipAttrs)` Raises a request to grant the roles identified by roleKeys to the specified user.
`boolean`	`isPendingRoleGrant(java.lang.String roleKey, java.lang.String userKey)` Return true if the user has the role granted in pending state.
`boolean`	`isRoleDynamicallyGranted(java.lang.String roleKey, java.lang.String userKey)` Return true if the user has the role dynamically granted.
`boolean`	`isRoleGranted(java.lang.String roleKey, java.lang.String userKey, boolean directAndIndirect)` Return true if the user has the role granted.
`boolean`	`isRoleParent(java.lang.String parentRoleKey, java.lang.String roleChildKey, boolean directAndIndirect)` Return true if the role has the given parent.
`RoleManagerResult`	`modify(Role role)` This method updates the existing role with the values specified.
`RoleManagerResult`	`modify(java.util.Set roleKeys, Role role)` Modifies roles in bulk.
`RoleManagerResult`	`modify(java.lang.String attributeName, java.lang.Object attributeValue, Role role)` This method modifies the role details for a role based on the search criteria `attributeName=attributeValue`.
`java.lang.String`	`modifyRequest(Role role)` This method raises a request to modify the existing role with the values specified.
`java.lang.String`	`modifyRequest(java.util.Set roleKeys, Role role)` Raises a request to modify roles in bulk.
`java.lang.String`	`modifyRequest(java.lang.String attributeName, java.lang.Object attributeValue, Role role)` This method raies a request to modify the role details for a role based on the search criteria `attributeName=attributeValue`.
`java.util.List`	`previewDynamicUserMembership(java.lang.String roleKey, SearchRule userMembershipRule, java.util.Set retAttrs, java.util.Map configParams)` Preview the user membership rule
`RoleManagerResult`	`removeRoleRelationship(java.lang.String parentAttrName, java.lang.Object parentAttrValue, java.lang.String childAttrName, java.lang.Object childAttrValue)` Remove a direct relationship between two roles, where the parent role is uniquely identified by the search criteria `parentAttrName=parentAttrValue` and the child role is uniquely identified by the search criteria `childAttrName=childAttrValue`.
`RoleManagerResult`	`removeRoleRelationship(java.lang.String roleParentKey, java.lang.String roleChildKey)` Remove a direct relationship between two roles.
`RoleManagerResult`	`revokeRoleGrant(java.lang.String roleAttributeName, java.lang.Object roleAttributeValue, java.lang.String userAttributeName, java.lang.Object userAttributeValue)` Revoke the role uniquely identified by the search criteria `roleAttributeName=roleAttributeValue` for the specified user uniquely identified by the search criteria `userAttributeName=userAttributeValue`.
`RoleManagerResult`	`revokeRoleGrant(java.lang.String roleKey, java.util.Set userKeys)` Revoke the role identified by `roleKey` to the specified user(s).
`RoleManagerResult`	`revokeRoleGrant(java.lang.String roleKey, java.util.Set userKeys, boolean evaluatePolicies)` Deprecated.
`java.lang.String`	`revokeRoleGrantRequest(java.lang.String roleAttributeName, java.lang.Object roleAttributeValue, java.lang.String userAttributeName, java.lang.Object userAttributeValue)` Raises a request to revoke the role uniquely identified by the search criteria `roleAttributeName=roleAttributeValue` for the specified user uniquely identified by the search criteria `userAttributeName=userAttributeValue`.
`java.lang.String`	`revokeRoleGrantRequest(java.lang.String roleKey, java.util.Set userKeys)` Raises a request to revoke the role identified by `roleKey` to the specified user(s).
`RoleManagerResult`	`revokeRoleGrants(java.lang.String userKey, java.util.Set roleKeys)` Revoke the roles identified by `roleKeys` to the user identified by `userKey`.
`java.lang.String`	`revokeRoleGrantsRequest(java.lang.String userKey, java.util.Set roleKeys)` Raises a request to revoke the roles identified by `roleKeys` to the user identified by `userKey`.
`java.util.List`	`search(SearchCriteria criteria, java.util.Set retAttrs, java.util.Map configParams)` Searches for roles matching the specified `SearchCriteria`.
`java.util.List`	`searchRoleHistory(java.lang.String roleKey, RoleManagerConstants.RoleHistoryType type, SearchCriteria criteria, java.util.Set retAttrs, java.util.Map configParams)` Search the role history for specific audit events/types of audit events.
`RoleManagerResult`	`setPendingRoleUserRelationshipAttributes(java.lang.String roleKey, java.lang.String userKey, java.util.Map relationshipAttrs)` Update the attributes of a pending role grant.
`java.lang.String`	`setPendingRoleUserRelationshipAttributesRequest(java.lang.String roleKey, java.lang.String userKey, java.util.Map relationshipAttrs)` Submits a request to update the attributes of a pending role grant.
`RoleManagerResult`	`setUserMembershipRule(java.lang.String roleKey, SearchRule userMembershipRule)` Sets the user membership rule on the specified Role
`RoleManagerResult`	`setUserMembershipRule(java.lang.String roleKey, SearchRule userMembershipRule, boolean evaluateMembershipLater)` Sets the user membership rule on the specified Role and membership is evaluated later if evaluateMembershipLater is passed as TRUE
`void`	`updateEntityDefinition()` This method updates UDF entry in Role.xml in MDS repository.
`RoleManagerResult`	`updateRoleGrant(java.lang.String roleAttributeName, java.lang.Object roleAttributeValue, java.lang.String userAttributeName, java.lang.Object userAttributeValue, java.util.Map args)` Update a role grant, where the role is identified uniquely by the search criteria `roleAttributeName=roleAttributeValue` and the user is uniquely identified by the search criteria `userAttributeName=userAttributeValue`.
`RoleManagerResult`	`updateRoleGrant(java.lang.String roleKey, java.lang.String userKey, java.util.Map args)` Update a role grant.
`RoleManagerResult`	`updateRoleRelationship(java.lang.String parentAttrName, java.lang.Object parentAttrValue, java.lang.String childAttrName, java.lang.Object childAttrValue, java.util.Map args)` Update a relationship between two roles, where the parent role is uniquely identified by the search criteria `parentAttrName=parentAttrValue` and the child role is uniquely identified by the search criteria `childAttrName=childAttrValue`.
`RoleManagerResult`	`updateRoleRelationship(java.lang.String roleKey, java.lang.String roleChildKey, java.util.Map args)` Update a relationship between two roles.

Method Detail

create

RoleManagerResult create(Role role)
                         throws ValidationFailedException,
                                AccessDeniedException,
                                RoleAlreadyExistsException,
                                RoleCreateException

This method creates a role.

Parameters:: role - The attributes and values for this role. The id field of the role should be null, please see Role.Role(java.util.HashMap) In addition to the setter methods, the following parameters can be passed:
List<String> which has the access policy keys
role.setAttribute(RoleManagerConstants.ACCESS_POLICIES, accessPolicies)
List<EntityPublication> to which the role needs to be published to
role.setAttribute(RoleManagerConstants.ORGANIZATIONS_PUBLISHED_TO, entityPubs);
List<HashMap<String, Serializable>> which has the user memberships
role.setAttribute(RoleManagerConstants.ROLE_MEMBERSHIPS, roleGrants);
List<String> which has the role parents
role.setAttribute(RoleManagerConstants.ROLE_PARENTS, roleParents);
catalogAttributes is a oracle.iam.catalog.vo.Catalog object
role.setAttribute(RoleManagerConstants.CATALOG_ATTRIBUTES, catalogAttributes);
userMembershipRule is a oracle.iam.platform.entitymgr.vo.SearchRule
role.setAttribute( RoleManagerConstants.RoleAttributeName.USER_MEMBERSHIP_RULE.getId(), userMembershipRule);
Detailed example in the javadoc at class level
Returns:: RoleManagerResult containing the entity id of the role created in the backend datastore. If Audit mode is enabled it will contain the Request ID.
Throws:: ValidationFailedException - if the validation during the orchestration process fails.; AccessDeniedException - if the logged-in user does not have the required authorization.; RoleAlreadyExistsException - if the role already exists.; RoleCreateException - if the orchestration fails for the create operation.

createRequest

java.lang.String createRequest(Role role)
                               throws ValidationFailedException,
                                      AccessDeniedException,
                                      RoleAlreadyExistsException,
                                      RoleCreateException

This method raises a request to create the role in the back end data store

Parameters:: role - The attributes and values for this role. The id field of the role should be null, please see Role.Role(java.util.HashMap)
Returns:: The id of the request.
Throws:: ValidationFailedException - if validation fails during the request creation.; AccessDeniedException - if the logged-in user does not have the required authorization.; RoleAlreadyExistsException - if the role already exists.; RoleCreateException - if the request creation fails for the create role operation.

modify

RoleManagerResult modify(Role role)
                         throws ValidationFailedException,
                                AccessDeniedException,
                                RoleModifyException,
                                NoSuchRoleException

This method updates the existing role with the values specified.

Parameters:: role - The attributes and values to update the role with. A non null value is must for the role role to identify the entity to be modified, Please see Role.Role(java.lang.String, java.util.HashMap). In addition to the setter methods, the following parameters can be passed:
Map<String, List<String>> accessPoliciesMap which contains the access policies to add and remove.
role.setAttribute(RoleManagerConstants.ACCESS_POLICIES, accessPoliciesMap)

Map<String, List<EntityPublication>> entityPubs of publications which needs to be added/updated/removed
role.setAttribute(RoleManagerConstants.ORGANIZATIONS_PUBLISHED_TO, entityPubs);

Map<String, List<RoleGrant>> roleGrants which has user memberships to be added/updated/removed.
role.setAttribute(RoleManagerConstants.ROLE_MEMBERSHIPS, roleGrants);

Map<String, List<String>> roleParents which has the role parents to be added/removed.
role.setAttribute(RoleManagerConstants.ROLE_PARENTS, roleParents);

catalogAttributes is a oracle.iam.catalog.vo.Catalog object
role.setAttribute(RoleManagerConstants.CATALOG_ATTRIBUTES, catalogAttributes);

userMembershipRule is a oracle.iam.platform.entitymgr.vo.SearchRule
role.setAttribute( RoleManagerConstants.RoleAttributeName.USER_MEMBERSHIP_RULE.getId(), userMembershipRule);
Detailed example in the javadoc at class level
Returns:: RoleManagerResult containing the entity id of the role updated in the backend datastore. If Audit mode is enabled it will contain the Request ID.
Throws:: ValidationFailedException - if the validation during the orchestration process fails.; AccessDeniedException - if the logged-in user does not have the required authorization.; RoleModifyException - if the orchestration fails for modify operation.; NoSuchRoleException - if the role with given key is not found.

modifyRequest

java.lang.String modifyRequest(Role role)
                               throws ValidationFailedException,
                                      AccessDeniedException,
                                      RoleModifyException,
                                      NoSuchRoleException

This method raises a request to modify the existing role with the values specified.

Parameters:: role - The attributes and values to update the role with. A non null value is must for the role role to identify the entity to be modified, Please see Role.Role(java.lang.String, java.util.HashMap).
Returns:: The id of the request.
Throws:: ValidationFailedException - if the validation fails during the request creation.; AccessDeniedException - if the logged-in user does not have the required authorization.; RoleModifyException - if the request creation fails for modify role operation.; NoSuchRoleException - if the role with given key is not found.

modify

RoleManagerResult modify(java.lang.String attributeName,
                         java.lang.Object attributeValue,
                         Role role)
                         throws ValidationFailedException,
                                AccessDeniedException,
                                RoleModifyException,
                                NoSuchRoleException,
                                SearchKeyNotUniqueException,
                                RoleLookupException

This method modifies the role details for a role based on the search criteria attributeName=attributeValue.

Parameters:: attributeName - The attribute name for the search criteria; attributeValue - The attribute value for the search criteria; role - The attributes and values to update the role with. The id field of the role should be null, please see Role.Role(java.util.HashMap).
Returns:: RoleManagerResult containing the entity id of the role updated in backend datastore. If Audit mode is enabled it will contain the Request ID.
Throws:: ValidationFailedException - if the validation during the orchestration process fails.; AccessDeniedException - if the logged-in user does not have the required authorization.; RoleModifyException - if the orchestration fails for modify operation.; NoSuchRoleException - if the role with given search criteria is not found.; SearchKeyNotUniqueException - if there is more than one role of the search criteria; RoleLookupException - if there is an exception while doing the search.

modifyRequest

java.lang.String modifyRequest(java.lang.String attributeName,
                               java.lang.Object attributeValue,
                               Role role)
                               throws ValidationFailedException,
                                      AccessDeniedException,
                                      RoleModifyException,
                                      NoSuchRoleException,
                                      SearchKeyNotUniqueException

This method raies a request to modify the role details for a role based on the search criteria attributeName=attributeValue.

Parameters:: attributeName - The attribute name for the search criteria; attributeValue - The attribute value for the search criteria; role - The attributes and values to update the role with. The id field of the role should be null, please see Role.Role(java.util.HashMap).
Returns:: The id of the request.
Throws:: ValidationFailedException - if the validation fails during the request creation.; AccessDeniedException - if the logged-in user does not have the required authorization.; RoleModifyException - if the request creation fails for modify role operation.; NoSuchRoleException - if the role with given search criteria is not found.; SearchKeyNotUniqueException - if there is more than one role of the search criteria; RoleLookupException - if there is an exception while doing the search.

delete

RoleManagerResult delete(java.lang.String attributeName,
                         java.lang.Object attributeValue)
                         throws SearchKeyNotUniqueException,
                                ValidationFailedException,
                                AccessDeniedException,
                                RoleDeleteException,
                                NoSuchRoleException,
                                RoleLookupException

This method deletes a role based on the search criteria attributeName=attributeValue.

Parameters:: attributeName - The attribute name for the search criteria; attributeValue - The attribute value for the search criteria
Returns:: RoleManagerResult containing the entity id of the role deleted in the backend datastore. If Audit mode is enabled it will contain the Request ID.
Throws:: SearchKeyNotUniqueException - if there is more than one role of the search criteria; ValidationFailedException - if the validation during the orchestration process fails.; AccessDeniedException - if the logged-in user does not have the required authorization.; RoleDeleteException - if the orchestration fails for delete operation.; NoSuchRoleException - if the role with given search criteria is not found.; RoleLookupException - if there is an exception while doing the search.

deleteRequest

java.lang.String deleteRequest(java.lang.String attributeName,
                               java.lang.Object attributeValue)
                               throws SearchKeyNotUniqueException,
                                      ValidationFailedException,
                                      AccessDeniedException,
                                      RoleDeleteException,
                                      NoSuchRoleException

This method raises a request to delete a role based on the search criteria attributeName=attributeValue.

Parameters:: attributeName - The attribute name for the search criteria; attributeValue - The attribute value for the search criteria
Returns:: The id of the request.
Throws:: SearchKeyNotUniqueException - if there is more than one role of the search criteria; ValidationFailedException - if the validation fails during the request creation.; AccessDeniedException - if the logged-in user does not have the required authorization.; RoleDeleteException - if the request creation fails for delete role operation.; NoSuchRoleException - if the role with given search criteria is not found.; RoleLookupException - if there is an exception while doing the search.

modify

RoleManagerResult modify(java.util.Set roleKeys,
                         Role role)
                         throws ValidationFailedException,
                                AccessDeniedException,
                                RoleModifyException,
                                NoSuchRoleException

Modifies roles in bulk. The profile of all roles whose key is in roleKeys set are updated with value of all bulk modifiable attribute specified in the map.

Parameters:: roleKeys - The keys of the roles whose profiles are to be updated.; role - The common set of attributes and values to update the roles with. The id field of the role should be null, please see Role.Role(java.util.HashMap).
Returns:: RoleManagerResult containing the set of success and failure results. Each failure result has a reason for failure associated with it.
Throws:: ValidationFailedException - if the validation during the orchestration process fails.; AccessDeniedException - if the logged-in user does not have the required authorization.; RoleModifyException - if the orchestration fails for modify operation.; NoSuchRoleException - if the role with given key is not found.

modifyRequest

java.lang.String modifyRequest(java.util.Set roleKeys,
                               Role role)
                               throws ValidationFailedException,
                                      AccessDeniedException,
                                      RoleModifyException,
                                      NoSuchRoleException

Raises a request to modify roles in bulk. The profile of all roles whose key is in roleKeys set are updated with value of all bulk modifiable attribute specified in the role object if the request is approved & completes successfully.

Parameters:: roleKeys - The keys of the roles whose profiles are to be updated.; role - The common set of attributes and values to update the roles with. The id field of the role should be null, please see Role.Role(java.util.HashMap).
Returns:: The id of the request.
Throws:: ValidationFailedException - if the validation fails during the request creations.; AccessDeniedException - if the logged-in user does not have the required authorization.; RoleModifyException - if the request creation fails for modify role operation.; NoSuchRoleException - if the role with given key is not found.

delete

RoleManagerResult delete(java.lang.String roleKey)
                         throws ValidationFailedException,
                                AccessDeniedException,
                                RoleDeleteException,
                                NoSuchRoleException

Delete the role. This is a hard delete operation and will remove the role from the data store.

Parameters:: roleKey - The key of the role to be deleted.
Returns:: RoleManagerResult containing the entity id of the role deleted in the backend datastore. If Audit mode is enabled it contains Request ID.
Throws:: ValidationFailedException - if the validation during the orchestration process fails.; AccessDeniedException - if the logged-in user does not have the required authorization.; RoleDeleteException - if the orchestration fails for delete operation.; NoSuchRoleException - if the role with given key is not found.

deleteRequest

java.lang.String deleteRequest(java.lang.String roleKey)
                               throws ValidationFailedException,
                                      AccessDeniedException,
                                      RoleDeleteException,
                                      NoSuchRoleException

Raises a request to delete the role.

Parameters:: roleKey - The key of the role to be deleted.
Returns:: The id of the rerequest.
Throws:: ValidationFailedException - if the validation fails during the request creation.; AccessDeniedException - if the logged-in user does not have the required authorization.; RoleDeleteException - if the request creation fails for delete role operation.; NoSuchRoleException - if the role with given key is not found.

delete

RoleManagerResult delete(java.util.Set roleKeys)
                         throws ValidationFailedException,
                                AccessDeniedException,
                                RoleDeleteException,
                                NoSuchRoleException

Bulk delete operation. It will delete all the specified roles.

Parameters:: roleKeys - The keys of the roles to be deleted.
Returns:: RoleManagerResult containing the set of success and failure results. Each failure result has a reason for failure associated with it.
Throws:: ValidationFailedException - if the validation during the orchestration process fails.; AccessDeniedException - if the logged-in user does not have the required authorization.; RoleDeleteException - if the orchestration fails for delete operation.; NoSuchRoleException - if the role with given key is not found.

deleteRequest

java.lang.String deleteRequest(java.util.Set roleKeys)
                               throws ValidationFailedException,
                                      AccessDeniedException,
                                      RoleDeleteException,
                                      NoSuchRoleException

Raises a request to delete all the specified roles.

Parameters:: roleKeys - The keys of the roles to be deleted.
Returns:: The id of the request.
Throws:: ValidationFailedException - if the validation fails during the request creation.; AccessDeniedException - if the logged-in user does not have the required authorization.; RoleDeleteException - if the request creation fails for delete role operation.; NoSuchRoleException - if the role with given key is not found.

getDetails

Role getDetails(java.lang.String roleKey,
                java.util.Set retAttrs)
                throws AccessDeniedException,
                       NoSuchRoleException,
                       RoleLookupException

Returns the profile details of the specified role.

Parameters:: roleKey - The key of the role who's details are required.; retAttrs - The set of attributes which are to be returned for each role. In addition to standard role attributes, the following can be passed RoleManagerConstants.ACCESS_POLICIES RoleManagerConstants.ORGANIZATIONS_PUBLISHED_TO RoleManagerConstants.CATALOG_ATTRIBUTES RoleManagerConstants.ROLE_USER_MEMBERSHIP_RULE
Returns:: If the role exists then an 'Role' object containing all the retAttrs of the role are returned otherwise NoSuchRoleException exception is thrown.
Throws:: AccessDeniedException - if the logged-in user does not have the required authorization.; RoleLookupException - if there is an exception while doing the search.; NoSuchRoleException - if the role with given key is not found.

getDetails

Role getDetails(java.lang.String roleKey,
                java.util.Set retAttrs,
                OperationContext opContext)
                throws AccessDeniedException,
                       NoSuchRoleException,
                       RoleLookupException

Returns the profile details of the specified role.

Parameters:: roleKey - The key of the role who's details are required.; retAttrs - The set of attributes which are to be returned for each role. In addition to standard role attributes, the following can be passed RoleManagerConstants.ACCESS_POLICIES RoleManagerConstants.ORGANIZATIONS_PUBLISHED_TO RoleManagerConstants.CATALOG_ATTRIBUTES RoleManagerConstants.ROLE_USER_MEMBERSHIP_RULE; opContext - Context of a request.
Returns:: If the role exists then an 'Role' object containing all the retAttrs of the role are returned otherwise NoSuchRoleException exception is thrown.
Throws:: AccessDeniedException - if the logged-in user does not have the required authorization.; RoleLookupException - if there is an exception while doing the search.; NoSuchRoleException - if the role with given key is not found.

getSimilarRoles

java.util.List getSimilarRoles(Role role)
                               throws RoleManagerException,
                                      AccessDeniedException

Finds similar roles based on entitlements. Only roles with 50% or higher match are considered. Only the top 3 matches are returned. For each matched role, its role memberships are also compared to determine the percentage of common users.

Note that since this API can be used during create and modify, the role will not exist during create operation. Hence, it is expected it to be populated with the access policies for both create and modify scenario. Role key need not be available. However, for modify operation, if the role vo doesn't have ALL its access policies and members populated, then the role key must be populated so the API can fetch the data. Role Name must be passed for modify, to filter out the passed role from the result.

Parameters:: role - The role for whome similar roles are required
Returns:: The list of top 3 matched similar role. List may contain more matches if multiple roles match with same percentage. List may have less than 3 matches if roles do not match the 50% cut-off. The Relationship has the following attributes: ROLE_KEY is the key of the matching role ROLE_NAME is the name of the matching role ENTITLEMENT_MATCH which is the percentage match for entitlements MEMBERSHIP_MATCH which gives the percentage of common members between the two roles
Throws:: ValidationFailedException; AccessDeniedException; RoleManagerException

search

java.util.List search(SearchCriteria criteria,
                      java.util.Set retAttrs,
                      java.util.Map configParams)
                      throws AccessDeniedException,
                             RoleSearchException

Searches for roles matching the specified SearchCriteria.

Parameters:

criteria - The search criteria based on which entries will be retrieved from the backend. The SearchCriteria Operators supported are AND, OR, NOT, GREATER_THAN, GREATER_EQUAL, LESS_THAN, LESS_EQUAL, EQUAL, NOT_EQUAL and CONTAINS.

retAttrs - The set of attributes which are to be returned for each role.

configParams - Parameters to further configure the search operation. There are four configuration parameters. STARTROW, ENDROW, SORTEDBY and SORTORDER.

The STARTROW and ENDROW search configuration parameters indicates which subset of the complete search result is to be fetched.

The SORTEDBY search configuration parameter indicates the attribute on which search result is to be sorted. This parameter is optional and is set to Role Name by default.

The SORTORDER search configuration parameter indicates the order of sorting. There are two possible values for this parameter. To sort the result in ascending order use SortOrder.ASCENDING and to sort the result in descending order use SortOrder.DESCENDING. This parameter is optional and is set to SortOrder.ASCENDING by default.

Returns:

the list of roles which matched the search criteria. This list is filtered based on the attribute and entity permissions of the logged-in user.

Throws:

AccessDeniedException - if the logged-in user does not have the required authorization.

RoleSearchException - if there is an exception while doing the search

getDetails

Role getDetails(java.lang.String attributeName,
                java.lang.Object attributeValue,
                java.util.Set retAttrs)
                throws SearchKeyNotUniqueException,
                       AccessDeniedException,
                       NoSuchRoleException,
                       RoleLookupException

This method return the role details for a role based on the search criteria attributeName=attributeValue.

Parameters:: attributeName - - The attribute name for the search criteria; attributeValue - - The attribute value for the search criteria; retAttrs - - The attributes to be returned for the role. In addition to standard role attributes, the following can be passed RoleManagerConstants.ACCESS_POLICIES RoleManagerConstants.ORGANIZATIONS_PUBLISHED_TO RoleManagerConstants.CATALOG_ATTRIBUTES RoleManagerConstants.ROLE_USER_MEMBERSHIP_RULE
Returns:: - The role that matches the search criteria
Throws:: SearchKeyNotUniqueException - if there is more than one role of the search criteria; AccessDeniedException - if the logged-in user does not have the required authorization.; RoleSearchException - if there is an exception while doing the search; NoSuchRoleException - if the role with given search criteria is not found; RoleLookupException - if there is an exception while doing the search.

grantRole

RoleManagerResult grantRole(java.lang.String roleKey,
                            java.util.Set userKeys)
                            throws ValidationFailedException,
                                   AccessDeniedException,
                                   RoleGrantException

Grant the role identified by roleKey to the specified user(s).

Parameters:: roleKey - The id of the role to be granted.; userKeys - The id(s) of the user to whom to grant the role.
Returns:: RoleManagerResult containing the set of success and failure results. Each failure result has a reason for failure associated with it.
Throws:: ValidationFailedException - if the validation during the orchestration process fails.; AccessDeniedException - if the logged-in user does not have the required authorization.; RoleGrantException - If operation fails.

grantRoleRequest

java.lang.String grantRoleRequest(java.lang.String roleKey,
                                  java.util.Set userKeys)
                                  throws ValidationFailedException,
                                         AccessDeniedException,
                                         RoleGrantException

Raises a request to grant the role identified by roleKey to the specified user/s.

Parameters:: roleKey - The id of the role to be granted.; userKeys - The id(s) of the user to whom to grant the role.
Returns:: The id of the request.
Throws:: ValidationFailedException - if the validation fails during the request creation.; AccessDeniedException - if the logged-in user does not have the required authorization.; RoleGrantException - If request creation fails.

grantRole

@Deprecated
RoleManagerResult grantRole(java.lang.String roleKey,
                                       java.util.Set userKeys,
                                       boolean evaluatePolicies)
                            throws ValidationFailedException,
                                   AccessDeniedException,
                                   RoleGrantException

Deprecated.

Grant the role identified by roleKey to the specified user(s).

Parameters:: roleKey - The id of the role to be granted.; userKeys - The id(s) of the user to whom to grant the role.; evaluatePolicies - Boolean to indicate whether to evaluate policies or not when user is granted to the role
Returns:: RoleManagerResult containing the set of success and failure results. Each failure result has a reason for failure associated with it.
Throws:: ValidationFailedException - if the validation during the orchestration process fails.; AccessDeniedException - if the logged-in user does not have the required authorization.; RoleGrantException - If operation fails.

revokeRoleGrant

RoleManagerResult revokeRoleGrant(java.lang.String roleKey,
                                  java.util.Set userKeys)
                                  throws ValidationFailedException,
                                         AccessDeniedException,
                                         RoleGrantRevokeException

Revoke the role identified by roleKey to the specified user(s).

Parameters:: roleKey - The id of the role to be revoked.; userKeys - The id(s) of the user to whom to revoke the role.
Returns:: RoleManagerResult containing the set of success and failure results. Each failure result has a reason for failure associated with it.
Throws:: ValidationFailedException - if the validation during the orchestration process fails.; AccessDeniedException - if the logged-in user does not have the required authorization.; RoleGrantRevokeException - If operation fails.

revokeRoleGrantRequest

java.lang.String revokeRoleGrantRequest(java.lang.String roleKey,
                                        java.util.Set userKeys)
                                        throws ValidationFailedException,
                                               AccessDeniedException,
                                               RoleGrantRevokeException

Raises a request to revoke the role identified by roleKey to the specified user(s).

Parameters:: roleKey - The id of the role to be revoked.; userKeys - The id(s) of the user to whom to revoke the role.
Returns:: The id of the request.
Throws:: ValidationFailedException - if the validation fails during the request creation.; AccessDeniedException - if the logged-in user does not have the required authorization.; RoleGrantRevokeException - If request creation fails.

revokeRoleGrant

@Deprecated
RoleManagerResult revokeRoleGrant(java.lang.String roleKey,
                                             java.util.Set userKeys,
                                             boolean evaluatePolicies)
                                  throws ValidationFailedException,
                                         AccessDeniedException,
                                         RoleGrantRevokeException

Deprecated.

Revoke the role identified by roleKey to the specified user/s.

Parameters:: roleKey - The id of the role to be revoked.; userKeys - The id(s) of the user to whom to revoke the role.; evaluatePolicies - Boolean to indicate whether to evaluate policies or not when user is revoked from the role
Returns:: RoleManagerResult containing the set of success and failure results. Each failure result has a reason for failure associated with it.
Throws:: ValidationFailedException - if the validation during the orchestration process fails.; AccessDeniedException - if the logged-in user does not have the required authorization.; RoleGrantRevokeException - If operation fails.

getRoleGrantDetails

Relationship getRoleGrantDetails(java.lang.String roleKey,
                                 java.lang.String userKey,
                                 java.util.Set retAttrs)
                                 throws AccessDeniedException,
                                        NoSuchRoleGrantException,
                                        RoleGrantLookupException

Lookup the attributes of a role grant, associated between roleKey and userKey.

Parameters:: roleKey - The id of the role whose grant we are looking up.; userKey - The id of the user whose grant we are looking up.; retAttrs - The attributes to lookup.
Returns:: Relationship containing the attributes of the role grant.
Throws:: ValidationFailedException - if the validation during the orchestration process fails.; AccessDeniedException - if the logged-in user does not have the required authorization.; RoleGrantLookupException - If operation fails.; NoSuchRoleGrantException - If the grant doesn't exist

grantRoles

RoleManagerResult grantRoles(java.lang.String userKey,
                             java.util.Set roleKeys)
                             throws ValidationFailedException,
                                    AccessDeniedException,
                                    RoleGrantException

Grant the roles identified by roleKeys to the user identified by userKey.

Parameters:: userKey - The key of the user to whom to grant the roles.; roleKeys - The keys of roles to be granted.
Returns:: RoleManagerResult containing the set of success and failure results. Each failure result has a reason for failure associated with it.
Throws:: ValidationFailedException - if the validation during the orchestration process fails.; AccessDeniedException - if the logged-in user does not have the required authorization.; RoleGrantException - If operation fails.

grantRolesRequest

java.lang.String grantRolesRequest(java.lang.String userKey,
                                   java.util.Set roleKeys)
                                   throws ValidationFailedException,
                                          AccessDeniedException,
                                          RoleGrantException

Raises a request to grant the roles identified by roleKeys to the user identified by userKey.

Parameters:: userKey - The key of the user to whom to grant the roles.; roleKeys - The keys of roles to be granted.
Returns:: The id of the request.
Throws:: ValidationFailedException - if the validation fails during the request creation.; AccessDeniedException - if the logged-in user does not have the required authorization.; RoleGrantException - If request creation fails.

revokeRoleGrants

RoleManagerResult revokeRoleGrants(java.lang.String userKey,
                                   java.util.Set roleKeys)
                                   throws ValidationFailedException,
                                          AccessDeniedException,
                                          RoleGrantRevokeException

Revoke the roles identified by roleKeys to the user identified by userKey.

Parameters:: userKey - The key of the user to whom to revoke the roles.; roleKeys - The keys of the roles to be revoked.
Returns:: RoleManagerResult containing the set of success and failure results. Each failure result has a reason for failure associated with it.
Throws:: ValidationFailedException - if the validation during the orchestration process fails.; AccessDeniedException - if the logged-in user does not have the required authorization.; RoleGrantRevokeException - If operation fails.

revokeRoleGrantsRequest

java.lang.String revokeRoleGrantsRequest(java.lang.String userKey,
                                         java.util.Set roleKeys)
                                         throws ValidationFailedException,
                                                AccessDeniedException,
                                                RoleGrantRevokeException

Raises a request to revoke the roles identified by roleKeys to the user identified by userKey.

Parameters:: userKey - The key of the user to whom to revoke the roles.; roleKeys - The keys of the roles to be revoked.
Returns:: The id of the request.
Throws:: ValidationFailedException - if the validation during the request creation.; AccessDeniedException - if the logged-in user does not have the required authorization.; RoleGrantRevokeException - If request creation fails.

updateRoleGrant

RoleManagerResult updateRoleGrant(java.lang.String roleKey,
                                  java.lang.String userKey,
                                  java.util.Map args)
                                  throws ValidationFailedException,
                                         AccessDeniedException,
                                         RoleGrantUpdateException,
                                         NoSuchRoleGrantException

Update a role grant.

Parameters:: roleKey - The key of the role whose grant we are updating.; userKey - The key of the user whose grant we are updating.; args - The attributes and values to update the role grant with.
Returns:: RoleManagerResult containing the status of the operation.
Throws:: ValidationFailedException - if the validation during the orchestration process fails.; AccessDeniedException - if the logged-in user does not have the required authorization.; RoleGrantUpdateException - If operation fails.; NoSuchRoleGrantException - If the role grant doesn't exist

getRoleMembers

java.util.List getRoleMembers(java.lang.String roleKey,
                              boolean directAndIndirect)
                              throws AccessDeniedException,
                                     RoleMemberException

Retrieve all the users members of the given role. It returns both static as well as dynamic role members. Note that this API only checks for direct and indirect memberships based on the directAndIndirect flag.

Parameters:: roleKey - The key of the role whose members we are looking up.; directAndIndirect - The flag used to lookup the role members either directly or indirectly. If the directAndIndirect is false, returns only direct assigned members to role. If the directAndIndirect is true, returns both direct and indirect assigned members of given role.
Returns:: the list of users that are members of the given role.
Throws:: AccessDeniedException - if the logged-in user does not have the required authorization.; RoleMemberException - If operation fails.

getDynamicRoleMembers

java.util.List getDynamicRoleMembers(java.lang.String roleKey)
                                     throws AccessDeniedException,
                                            RoleMemberException

Retrieve all the dynamic users members of the given role. Dynamic users members are based on the user membership rule

Parameters:: roleKey - The key of the role whose members we are looking up.
Returns:: the list of users that are dynamic members of the given role.
Throws:: AccessDeniedException - if the logged-in user does not have the required authorization.; RoleMemberException - If operation fails.

getDynamicRoleMembers

java.util.List getDynamicRoleMembers(java.lang.String roleKey,
                                     java.util.Set retAttrs,
                                     java.util.Map configParams)
                                     throws AccessDeniedException,
                                            RoleMemberException

Retrieve all the dynamic users members of the given role. Dynamic users members are based on the user membership rule

Parameters:

roleKey - The key of the role whose members we are looking up.

retAttrs - The set of attributes which are to be returned for each user.

configParams - Parameters to further configure the search operation. There are four configuration parameters. STARTROW, ENDROW, SORTEDBY and SORTORDER.

The STARTROW and ENDROW search configuration parameters indicates which subset of the complete search result is to be fetched.

The SORTEDBY search configuration parameter indicates the attribute on which search result is to be sorted. This parameter is optional and is set to User Key by default.

Returns:

the list of users that are dynamic members of the given role.

Throws:

AccessDeniedException - if the logged-in user does not have the required authorization.

RoleMemberException - If operation fails.

getRoleMembers

java.util.List getRoleMembers(java.lang.String roleKey,
                              SearchCriteria criteria,
                              java.util.Set retAttrs,
                              java.util.Map configParams,
                              boolean directAndIndirect)
                              throws AccessDeniedException,
                                     RoleMemberException

Retrieve the users members of the given role matching the specified SearchCriteria. This method returns both static as well as dynamic members.

Parameters:

roleKey - The key of the role whose members we are looking up.

retAttrs - The set of attributes which are to be returned for each user.

configParams - Parameters to further configure the search operation. There are four configuration parameters. STARTROW, ENDROW, SORTEDBY and SORTORDER.

The STARTROW and ENDROW search configuration parameters indicates which subset of the complete search result is to be fetched.

The SORTEDBY search configuration parameter indicates the attribute on which search result is to be sorted. This parameter is optional and is set to User Key by default.

directAndIndirect - if the directAndIndirect is false returns only direct assigned members to role which are matched with search criteria.if the directAndIndirect is true returns both direct and indirect assigned members of given role which are matched with search criteria.

Returns:

the list of users that are members of the given role which matched the search criteria. This list is filtered based on the attribute and entity permissions of the logged-in user.

Throws:

AccessDeniedException - if the logged-in user does not have the required authorization.

RoleMemberException - If operation fails.

getPendingUserGrants

java.util.List getPendingUserGrants(java.lang.String userKey,
                                    java.util.Set retAttrs,
                                    java.util.Map configParams)
                                    throws AccessDeniedException,
                                           RoleMemberException

Retrieve the pending role grants of the given user. This method returns static grants with future start date.

Parameters:

userKey - The key of the user whose pending role grants we are looking up.

retAttrs - The set of attributes which are to be returned for each role.

configParams - Parameters to further configure the search operation. There are four configuration parameters. STARTROW, ENDROW, SORTEDBY and SORTORDER.

The STARTROW and ENDROW search configuration parameters indicates which subset of the complete search result is to be fetched.

The SORTEDBY search configuration parameter indicates the attribute on which search result is to be sorted. This parameter is optional and is set to User Key by default.

Returns:

the list of future role grants List<RoleGrant> which matched the search criteria. This list is filtered based on the attribute and entity permissions of the logged-in user.

Throws:

AccessDeniedException - if the logged-in user does not have the required authorization.

RoleMemberException - If operation fails.

getPendingRoleGrants

java.util.List getPendingRoleGrants(java.lang.String roleKey,
                                    java.util.Set retAttrs,
                                    java.util.Map configParams)
                                    throws AccessDeniedException,
                                           RoleMemberException

Retrieve the pending role grants of the given role. This method returns static grants with future start date.

Parameters:

roleKey - The key of the role whose pending members we are looking up.

retAttrs - The set of attributes which are to be returned for each user.

configParams - Parameters to further configure the search operation. There are four configuration parameters. STARTROW, ENDROW, SORTEDBY and SORTORDER.

The STARTROW and ENDROW search configuration parameters indicates which subset of the complete search result is to be fetched.

The SORTEDBY search configuration parameter indicates the attribute on which search result is to be sorted. This parameter is optional and is set to User Key by default.

Returns:

the list of future role grants List<RoleGrant> which matched the search criteria. This list is filtered based on the attribute and entity permissions of the logged-in user.

Throws:

AccessDeniedException - if the logged-in user does not have the required authorization.

RoleMemberException - If operation fails.

getRoleIndirectMembers

java.util.List getRoleIndirectMembers(java.lang.String roleKey,
                                      SearchCriteria criteria,
                                      java.util.Set retAttrs,
                                      java.util.Map configParams)
                                      throws AccessDeniedException,
                                             RoleMemberException

Retrieve the indirect members (users) of the given role matching the specified SearchCriteria.

Parameters:

roleKey - The key of the role whose indirect members we are looking up.

retAttrs - The set of attributes which are to be returned for each user.

configParams - Parameters to further configure the search operation. There are four configuration parameters. STARTROW, ENDROW, SORTEDBY and SORTORDER.

The STARTROW and ENDROW search configuration parameters indicates which subset of the complete search result is to be fetched.

The SORTEDBY search configuration parameter indicates the attribute on which search result is to be sorted. This parameter is optional and is set to User Key by default.

Returns:

the list of users that are indirect members of the given role.

Throws:

AccessDeniedException - if the logged-in user does not have the required authorization.

RoleMemberException - If operation fails.

getUnassignedRoleMembers

java.util.List getUnassignedRoleMembers(java.lang.String roleKey)
                                        throws AccessDeniedException,
                                               RoleMemberException

Retrieve all the users that are not direct members of the given role. Note that this API only checks for direct memberships.

Parameters:: roleKey - The key of the role whose not direct members we are looking up.
Returns:: the list of users that are not members of the given role.
Throws:: AccessDeniedException - if the logged-in user does not have the required authorization.; RoleMemberException - If operation fails.

getUnassignedRoleMembers

java.util.List getUnassignedRoleMembers(java.lang.String roleKey,
                                        SearchCriteria criteria,
                                        java.util.Set retAttrs,
                                        java.util.Map configParams)
                                        throws AccessDeniedException,
                                               RoleMemberException

Retrieve all the users that are not direct members of the given role matching the specified SearchCriteria.

Parameters:

roleKey - The key of the role whose not direct members we are looking up.

retAttrs - The set of attributes which are to be returned for each user.

configParams - Parameters to further configure the search operation. There are four configuration parameters. STARTROW, ENDROW, SORTEDBY and SORTORDER.

The STARTROW and ENDROW search configuration parameters indicates which subset of the complete search result is to be fetched.

The SORTEDBY search configuration parameter indicates the attribute on which search result is to be sorted. This parameter is optional and is set to User Key by default.

Returns:

the list of users that are not direct members of the given role which matched the search criteria. This list is filtered based on the attribute and entity permissions of the logged-in user.

Throws:

AccessDeniedException - if the logged-in user does not have the required authorization.

RoleMemberException - If operation fails.

isRoleGranted

boolean isRoleGranted(java.lang.String roleKey,
                      java.lang.String userKey,
                      boolean directAndIndirect)
                      throws AccessDeniedException,
                             UserMembershipException

Return true if the user has the role granted. This method works for both static as well as dynamic members. Note that this API only checks for direct and indirect memberships based on the directAndIndirect flag.

Parameters:: roleKey - The key of the role whose memberships we are looking up.; userKey - The key of the user whose memberships we are looking up.; directAndIndirect - if true, checks for both direct and indirect memberships. if false, checks for only direct memberships.
Returns:: true if the user had the role granted.
Throws:: AccessDeniedException - if the logged-in user does not have the required authorization.; UserMembershipException - If operation fails.

isRoleDynamicallyGranted

boolean isRoleDynamicallyGranted(java.lang.String roleKey,
                                 java.lang.String userKey)
                                 throws AccessDeniedException,
                                        UserMembershipException

Return true if the user has the role dynamically granted. Dynamic role grants are based on the user membership rule

Parameters:: roleKey - The key of the role whose memberships we are looking up.; userKey - The key of the user whose memberships we are looking up.
Returns:: true if the user had the role dynamically granted.
Throws:: AccessDeniedException - if the logged-in user does not have the required authorization.; UserMembershipException - If operation fails.

getUserMemberships

java.util.List getUserMemberships(java.lang.String userKey,
                                  boolean directAndIndirect)
                                  throws AccessDeniedException,
                                         UserMembershipException

Retrieve all the roles that the user is a member of. This method works for both static as well as dynamically granted roles. Note that this API checks for direct and indirect memberships based on the directAndIndirect flag.

Parameters:: userKey - The key of the user whose memberships we are looking up.; directAndIndirect - The flag used to lookup the user memberships either directly or indirectly. If true, checks for both direct and indirect memberships. If false, checks for only direct memberships.
Returns:: the list of roles that are granted to the given user.
Throws:: AccessDeniedException - if the logged-in user does not have the required authorization.; UserMembershipException - If operation fails.

getUserMemberships

java.util.List getUserMemberships(java.lang.String userKey,
                                  SearchCriteria criteria,
                                  java.util.Set retAttrs,
                                  java.util.Map configParams,
                                  boolean directAndIndirect)
                                  throws AccessDeniedException,
                                         UserMembershipException

Retrieve the roles of the given user matching the specified SearchCriteria. This method works for both static as well as dynamically granted roles. Note that this API only checks for direct and indirect memberships based on the directAndIndirect flag.

Parameters:

userKey - The key of the user whose memberships we are looking up.

retAttrs - The set of attributes which are to be returned for each role.

configParams - Parameters to further configure the search operation. There are four configuration parameters. STARTROW, ENDROW, SORTEDBY and SORTORDER.

The STARTROW and ENDROW search configuration parameters indicates which subset of the complete search result is to be fetched.

The SORTEDBY search configuration parameter indicates the attribute on which search result is to be sorted. This parameter is optional and is set to User Key by default.

directAndIndirect - The flag used to lookup the user memberships either directly or indirectly. If true, checks for both direct and indirect memberships. If false, checks for only direct memberships.

Returns:

the list of roles that are granted to the given user.

Throws:

AccessDeniedException - if the logged-in user does not have the required authorization.

UserMembershipException - If operation fails.

getUserRoleGrants

java.util.List getUserRoleGrants(java.lang.String userKey,
                                 SearchCriteria criteria,
                                 java.util.Map configParams,
                                 boolean directAndIndirect,
                                 java.util.Set roleGrantRetAttrs,
                                 java.util.Set roleRetAttrs,
                                 java.util.Set userRetAttrs)
                                 throws AccessDeniedException,
                                        UserMembershipException,
                                        NoSuchRoleGrantException,
                                        RoleGrantLookupException,
                                        NoSuchUserException,
                                        UserLookupException

Retrieve the role grants of the given user matching the specified SearchCriteria. This method works for both static as well as dynamically granted roles. Note that this API only checks for direct and indirect memberships based on the directAndIndirect flag.

Parameters:

userKey - The key of the user whose memberships we are looking up. Required.

criteria - The search criteria based on which roles will be retrieved from the backend. The SearchCriteria Operators supported are AND, OR, NOT, GREATER_THAN, GREATER_EQUAL, LESS_THAN, LESS_EQUAL, EQUAL, NOT_EQUAL and CONTAINS.

configParams - Parameters to further configure the search operation. These parameters apply to the role entities. If configParams argument is null, defaults are all rows, in ascending order by role key. There are four configuration parameters. STARTROW, ENDROW, SORTEDBY and SORTORDER.

The STARTROW and ENDROW search configuration parameters indicates which subset of the complete search result is to be fetched.

The SORTEDBY search configuration parameter indicates the attribute on which search result is to be sorted. This parameter is optional and is set to Role Key by default.

directAndIndirect - The flag used to lookup the user memberships either directly or indirectly. If true, checks for direct and indirect memberships. If false, only direct memberships are returned.

roleGrantRetAttrs - The set of attributes which are to be returned for each role grant. If null, all attributes are returned.

roleRetAttrs - The set of attributes which are to be returned for each role. If null, the role object is not returned.

userRetAttrs - The set of attributes which are to be returned for each user. If null, the user object is not returned.

Returns:

The list of role-user relationships.

Throws:

AccessDeniedException - If the logged-in user does not have the required authorization.

UserMembershipException - If operation fails.

RoleGrantLookupException - If role grant lookup fails.

NoSuchRoleGrantException - If the grant doesn't exist

NoSuchUserException - If the user does not exist.

UserLookupException - If the user lookup operation fails.

getUnassignedUserMemberships

java.util.List getUnassignedUserMemberships(java.lang.String userKey,
                                            SearchCriteria criteria,
                                            java.util.Set retAttrs,
                                            java.util.Map configParams)
                                            throws AccessDeniedException,
                                                   UserMembershipException

Retrieve all the roles that are not direct memberships of the given user matching the specified SearchCriteria.

Parameters:

userKey - The key of the user whose not direct memberships we are looking up.

retAttrs - The set of attributes which are to be returned for each role.

configParams - Parameters to further configure the search operation. There are four configuration parameters. STARTROW, ENDROW, SORTEDBY and SORTORDER.

The STARTROW and ENDROW search configuration parameters indicates which subset of the complete search result is to be fetched.

The SORTEDBY search configuration parameter indicates the attribute on which search result is to be sorted. This parameter is optional and is set to User Key by default.

Returns:

the list of roles that are not directly granted to the given user.

Throws:

AccessDeniedException - if the logged-in user does not have the required authorization.

UserMembershipException - If operation fails.

addRoleRelationship

RoleManagerResult addRoleRelationship(java.lang.String roleParentKey,
                                      java.lang.String roleChildKey)
                                      throws ValidationFailedException,
                                             AccessDeniedException,
                                             RoleRelationshipException

Add a direct relationship between two roles.

Parameters:: roleParentKey - The key of the parent role in the relationship that we are creating.; roleChildKey - The key of the child role in the relationship that we are creating.
Returns:: RoleManagerResult containing the status of the operation.
Throws:: ValidationFailedException - if the validation during the orchestration process fails.; AccessDeniedException - if the logged-in user does not have the required authorization.; RoleRelationshipException - If operation fails.

removeRoleRelationship

RoleManagerResult removeRoleRelationship(java.lang.String roleParentKey,
                                         java.lang.String roleChildKey)
                                         throws ValidationFailedException,
                                                AccessDeniedException,
                                                RoleRelationshipRemoveException

Remove a direct relationship between two roles.

Parameters:: roleParentKey - The key of the parent role in the relationship that we are deleting.; roleChildKey - The key of the child role in the relationship that we are deleting.
Returns:: RoleManagerResult containing the status of the operation.
Throws:: ValidationFailedException - if the validation during the orchestration process fails.; AccessDeniedException - if the logged-in user does not have the required authorization.; RoleRelationshipRemoveException - If operation fails.

getRoleRelationshipDetails

Relationship getRoleRelationshipDetails(java.lang.String roleParentKey,
                                        java.lang.String roleChildKey,
                                        java.util.Set retAttrs)
                                        throws AccessDeniedException,
                                               NoSuchRoleRelationshipException,
                                               RoleRelationshipLookupException

Lookup the attributes of a role relationship.

Parameters:: roleParentKey - The key of the parent role in the relationship we are looking up.; roleChildKey - The key of the child role in the relationship we are looking up.; retAttrs - The attributes to lookup.
Returns:: Relationship containing the attributes of the role relationship.
Throws:: ValidationFailedException - if the validation during the orchestration process fails.; AccessDeniedException - if the logged-in user does not have the required authorization.; RoleRelationshipLookupException - If operation fails.; NoSuchRoleRelationshipException - If the role relationship doesn't exist

updateRoleRelationship

RoleManagerResult updateRoleRelationship(java.lang.String roleKey,
                                         java.lang.String roleChildKey,
                                         java.util.Map args)
                                         throws ValidationFailedException,
                                                AccessDeniedException,
                                                RoleRelationshipUpdateException,
                                                NoSuchRoleRelationshipException

Update a relationship between two roles.

Parameters:: roleKey - The key of the parent role in the relationship that we are updating.; roleChildKey - The key of the child role in the relationship that we are updating.; args - The attributes and values to update the role relationship with.
Returns:: RoleManagerResult containing the status of the operation.
Throws:: ValidationFailedException - if the validation during the orchestration process fails.; AccessDeniedException - if the logged-in user does not have the required authorization.; RoleRelationshipUpdateException - If operation fails.; NoSuchRoleRelationshipException - If the relationship doesn't exist

getRoleChildren

java.util.List getRoleChildren(java.lang.String roleParentKey,
                               boolean directAndIndirect)
                               throws AccessDeniedException,
                                      RoleMemberException

Retrieve the roles children of the given role. Note that this API only checks for direct and indirect relationships based on the directAndIndirect flag.

Parameters:: roleParentKey - The key of the role whose relationships are looking up.; directAndIndirect - The flag used to lookup the role relationships either directly or indirectly. If true, returns all the children, including both direct and indirect. If false, returns only direct children.
Returns:: the list of roles that are children of the given role.
Throws:: AccessDeniedException - if the logged-in user does not have the required authorization.; RoleMemberException - If operation fails.

getDirectRoleChildren

java.util.List getDirectRoleChildren(java.lang.String roleParentKey,
                                     java.util.Set retAttrs,
                                     java.util.Map configParams)
                                     throws AccessDeniedException,
                                            RoleMemberException

Retrieve the roles direct children of the given role.

Parameters:: roleParentKey - The key of the role whose children are looking up.; retAttrs - The set of attributes which are to be returned for each role.; configParams - Parameters to further configure the search operation. There are two configuration parameters. STARTROW, and ENDROW The STARTROW and ENDROW search configuration parameters indicates which subset of the complete search result is to be fetched.
Returns:: the list of roles that are direct children of the given role.
Throws:: AccessDeniedException - if the logged-in user does not have the required authorization.; RoleMemberException - If operation fails.

isRoleParent

boolean isRoleParent(java.lang.String parentRoleKey,
                     java.lang.String roleChildKey,
                     boolean directAndIndirect)
                     throws AccessDeniedException,
                            RoleMemberException

Return true if the role has the given parent. Note that this API only checks for for direct and indirect relationships based on the directAndIndirect flag.

Parameters:: parentRoleKey - The key of the role whose relationship we are looking up.; directAndIndirect - if true, checks for direct and indirect relationships. If false, checks for only direct relationships.; roleChildKey - The key of the role whose relationship we are looking up.
Returns:: true if the role has the given parent.
Throws:: AccessDeniedException - if the logged-in user does not have the required authorization.; RoleMemberException - If operation fails.

getRoleParents

java.util.List getRoleParents(java.lang.String roleChildKey,
                              boolean directAndIndirect)
                              throws AccessDeniedException,
                                     RoleMemberException

Retrieve the roles who are the parents of the given role. Note that this API checks for direct and indirect relationship based on directAndIndirect

Parameters:: roleChildKey - The key of the role whose parent we are looking up.; directAndIndirect - When set to false, will only return direct parents. When set to true, will return direct and indirect parents.
Returns:: the list of roles who are the parents of the given role.
Throws:: AccessDeniedException - if the logged-in user does not have the required authorization.; RoleMemberException - If operation fails.

getDirectRoleParents

java.util.List getDirectRoleParents(java.lang.String roleChildKey,
                                    java.util.Set retAttrs,
                                    java.util.Map configParams)
                                    throws AccessDeniedException,
                                           RoleMemberException

Retrieve the roles who are the direct parents of the given role.

Parameters:: roleChildKey - the key of the role whose parents are looking up.; retAttrs - The set of attributes which are to be returned for each role.; configParams - Parameters to further configure the search operation. There are two configuration parameters. STARTROW, and ENDROW The STARTROW and ENDROW search configuration parameters indicates which subset of the complete search result is to be fetched.
Returns:: the list of roles who are the direct parents of the given role.
Throws:: AccessDeniedException - if the logged-in user does not have the required authorization.; RoleMemberException - If operation fails.

updateEntityDefinition

void updateEntityDefinition()

This method updates UDF entry in Role.xml in MDS repository. An assumption is that any UDF in Role.xml will only be added or modified through Design console. This API is being invoked from Design console. tcfrmUDFManager. This will be called when user has made any modification in UDF of Roles only.

grantRole

RoleManagerResult grantRole(java.lang.String roleAttributeName,
                            java.lang.Object roleAttributeValue,
                            java.lang.String userAttributeName,
                            java.lang.Object userAttributeValue)
                            throws ValidationFailedException,
                                   AccessDeniedException,
                                   RoleGrantException,
                                   SearchKeyNotUniqueException,
                                   NoSuchRoleException,
                                   NoSuchUserException

Grant the role(s) are identified by the search criteria roleAttributeName=roleAttributeValue to the specified user(s) identified by the search criteria userAttributeName=userAttributeValue.

Parameters:: roleAttributeName - The role attribute name for the search criteria.; roleAttributeValue - The role attribute value for the search criteria.; userAttributeName - The user attribute name for the search criteria.; userAttributeValue - The user attribute value for the search criteria.
Returns:: RoleManagerResult containing the set of success and failure results. Each failure result has a reason for failure associated with it.
Throws:: ValidationFailedException - if the validation during the orchestration process fails.; AccessDeniedException - if the logged-in user does not have the required. authorization.; RoleGrantException - If operation fails.; SearchKeyNotUniqueException - if there is more than one roles or users for the given search criteria.; NoSuchRoleException - if the role with given search criteria is not found.; NoSuchUserException - if the user with given search criteria is not found.

grantRoleRequest

java.lang.String grantRoleRequest(java.lang.String roleAttributeName,
                                  java.lang.Object roleAttributeValue,
                                  java.lang.String userAttributeName,
                                  java.lang.Object userAttributeValue)
                                  throws ValidationFailedException,
                                         AccessDeniedException,
                                         RoleGrantException,
                                         SearchKeyNotUniqueException,
                                         NoSuchRoleException,
                                         NoSuchUserException

Raises a request to grant the role(s) are identified by the search criteria roleAttributeName=roleAttributeValue to the specified user(s) identified by the search criteria userAttributeName=userAttributeValue.

Parameters:: roleAttributeName - The role attribute name for the search criteria.; roleAttributeValue - The role attribute value for the search criteria.; userAttributeName - The user attribute name for the search criteria.; userAttributeValue - The user attribute value for the search criteria.
Returns:: The id of the reuest.
Throws:: ValidationFailedException - if the validation fails during the request creation.; AccessDeniedException - if the logged-in user does not have the required. authorization.; RoleGrantException - If request creation fails.; SearchKeyNotUniqueException - if there is more than one roles or users for the given search criteria.; NoSuchRoleException - if the role with given search criteria is not found.; NoSuchUserException - if the user with given search criteria is not found.

getRoleGrantDetails

Relationship getRoleGrantDetails(java.lang.String roleAttributeName,
                                 java.lang.Object roleAttributeValue,
                                 java.lang.String userAttributeName,
                                 java.lang.Object userAttributeValue,
                                 java.util.Set retAttrs)
                                 throws AccessDeniedException,
                                        NoSuchRoleGrantException,
                                        RoleGrantLookupException,
                                        SearchKeyNotUniqueException,
                                        NoSuchRoleException,
                                        NoSuchUserException

Lookup the attributes of a role grant, where the role is identified uniquely by the search criteria roleAttributeName=roleAttributeValue and the user is uniquely identified by the search criteria userAttributeName=userAttributeValue.

Parameters:: roleAttributeName - The role attribute name for the search criteria.; roleAttributeValue - The role attribute value for the search criteria.; userAttributeName - The user attribute name for the search criteria.; userAttributeValue - The user attribute value for the search criteria.; retAttrs - The attributes to lookup.
Returns:: Relationship containing the attributes of the role grant.
Throws:: AccessDeniedException - if the logged-in user does not have the required authorization.; RoleGrantLookupException - If operation fails.; NoSuchRoleGrantException - If the grant doesn't exist.; SearchKeyNotUniqueException - if there is more than one roles or users for the given search criteria.; NoSuchRoleException - if the role with given search criteria is not found.; NoSuchUserException - if the user with given search criteria is not found.

updateRoleGrant

RoleManagerResult updateRoleGrant(java.lang.String roleAttributeName,
                                  java.lang.Object roleAttributeValue,
                                  java.lang.String userAttributeName,
                                  java.lang.Object userAttributeValue,
                                  java.util.Map args)
                                  throws ValidationFailedException,
                                         AccessDeniedException,
                                         RoleGrantUpdateException,
                                         NoSuchRoleGrantException,
                                         SearchKeyNotUniqueException,
                                         NoSuchRoleException,
                                         NoSuchUserException

Update a role grant, where the role is identified uniquely by the search criteria roleAttributeName=roleAttributeValue and the user is uniquely identified by the search criteria userAttributeName=userAttributeValue.

Parameters:: roleAttributeName - The role attribute name for the search criteria.; roleAttributeValue - The role attribute value for the search criteria.; userAttributeName - The user attribute name for the search criteria.; userAttributeValue - The user attribute value for the search criteria.; args - The attributes and values to update the role grant with.
Returns:: RoleManagerResult containing the status of the operation.
Throws:: ValidationFailedException - if the validation during the orchestration process fails.; AccessDeniedException - if the logged-in user does not have the required authorization.; RoleGrantUpdateException - If operation fails.; NoSuchRoleGrantException - If the role grant doesn't exist.; SearchKeyNotUniqueException - if there is more than one roles or users for the given search criteria.; NoSuchRoleException - if the role with given search criteria is not found.; NoSuchUserException - if the user with given search criteria is not found.

revokeRoleGrant

RoleManagerResult revokeRoleGrant(java.lang.String roleAttributeName,
                                  java.lang.Object roleAttributeValue,
                                  java.lang.String userAttributeName,
                                  java.lang.Object userAttributeValue)
                                  throws ValidationFailedException,
                                         AccessDeniedException,
                                         RoleGrantRevokeException,
                                         SearchKeyNotUniqueException,
                                         NoSuchRoleException,
                                         NoSuchUserException

Revoke the role uniquely identified by the search criteria roleAttributeName=roleAttributeValue for the specified user uniquely identified by the search criteria userAttributeName=userAttributeValue.

Parameters:: roleAttributeName - The role attribute name for the search criteria.; roleAttributeValue - The role attribute value for the search criteria.; userAttributeName - The user attribute name for the search criteria.; userAttributeValue - The user attribute value for the search criteria.
Returns:: RoleManagerResult containing the set of success and failure results. Each failure result has a reason for failure associated with it.
Throws:: ValidationFailedException - if the validation during the orchestration process fails.; AccessDeniedException - if the logged-in user does not have the required authorization.; RoleGrantRevokeException - If operation fails.; SearchKeyNotUniqueException - if there is more than one roles or users for the given search criteria.; NoSuchRoleException - if the role with given search criteria is not found.; NoSuchUserException - if the user with given search criteria is not found.

revokeRoleGrantRequest

java.lang.String revokeRoleGrantRequest(java.lang.String roleAttributeName,
                                        java.lang.Object roleAttributeValue,
                                        java.lang.String userAttributeName,
                                        java.lang.Object userAttributeValue)
                                        throws ValidationFailedException,
                                               AccessDeniedException,
                                               RoleGrantRevokeException,
                                               SearchKeyNotUniqueException,
                                               NoSuchRoleException,
                                               NoSuchUserException

Raises a request to revoke the role uniquely identified by the search criteria roleAttributeName=roleAttributeValue for the specified user uniquely identified by the search criteria userAttributeName=userAttributeValue.

Parameters:: roleAttributeName - The role attribute name for the search criteria.; roleAttributeValue - The role attribute value for the search criteria.; userAttributeName - The user attribute name for the search criteria.; userAttributeValue - The user attribute value for the search criteria.
Returns:: The id of the request.
Throws:: ValidationFailedException - if the validation fails during the request creation.; AccessDeniedException - if the logged-in user does not have the required authorization.; RoleGrantRevokeException - If request creation fails.; SearchKeyNotUniqueException - if there is more than one roles or users for the given search criteria.; NoSuchRoleException - if the role with given search criteria is not found.; NoSuchUserException - if the user with given search criteria is not found.

getRoleRelationshipDetails

Relationship getRoleRelationshipDetails(java.lang.String parentAttrName,
                                        java.lang.Object parentAttrValue,
                                        java.lang.String childAttrName,
                                        java.lang.Object childAttrValue,
                                        java.util.Set retAttrs)
                                        throws AccessDeniedException,
                                               NoSuchRoleRelationshipException,
                                               RoleRelationshipLookupException,
                                               SearchKeyNotUniqueException,
                                               NoSuchRoleException

Lookup the attributes of a role relationship, where the parent role is uniquely identified by the search criteria parentAttrName=parentAttrValue and the child role is uniquely identified by the search criteria childAttrName=childAttrValue.

Parameters:: parentAttrName - The parent role attribute name for the search criteria.; parentAttrValue - The parent role attribute value for the search criteria.; childAttrName - The child role attribute name for the search criteria.; childAttrValue - The child role attribute value for the search criteria.; retAttrs - The attributes to lookup.
Returns:: Relationship containing the attributes of the role relationship.
Throws:: ValidationFailedException - if the validation during the orchestration process fails.; AccessDeniedException - if the logged-in user does not have the required authorization.; RoleRelationshipLookupException - If operation fails.; NoSuchRoleRelationshipException - If the role relationship doesn't exist.; SearchKeyNotUniqueException - if there is more than one roles for the given search criteria.; NoSuchRoleException - if the role with given search criteria is not found.

addRoleRelationship

RoleManagerResult addRoleRelationship(java.lang.String parentAttrName,
                                      java.lang.Object parentAttrValue,
                                      java.lang.String childAttrName,
                                      java.lang.Object childAttrValue)
                                      throws ValidationFailedException,
                                             AccessDeniedException,
                                             RoleRelationshipException,
                                             SearchKeyNotUniqueException,
                                             NoSuchRoleException

Add a direct relationship between two roles, where the parent role is uniquely identified by the search criteria parentAttrName=parentAttrValue and the child role is uniquely identified by the search criteria childAttrName=childAttrValue.

Parameters:: parentAttrName - The parent role attribute name for the search criteria.; parentAttrValue - The parent role attribute value for the search criteria.; childAttrName - The child role attribute name for the search criteria.; childAttrValue - The child role attribute value for the search criteria.
Returns:: RoleManagerResult containing the status of the operation.
Throws:: ValidationFailedException - if the validation during the orchestration process fails.; AccessDeniedException - if the logged-in user does not have the required authorization.; RoleRelationshipException - If operation fails.; SearchKeyNotUniqueException - if there is more than one roles for the given search criteria.; NoSuchRoleException - if the role with given search criteria is not found.

removeRoleRelationship

RoleManagerResult removeRoleRelationship(java.lang.String parentAttrName,
                                         java.lang.Object parentAttrValue,
                                         java.lang.String childAttrName,
                                         java.lang.Object childAttrValue)
                                         throws ValidationFailedException,
                                                AccessDeniedException,
                                                RoleRelationshipRemoveException,
                                                SearchKeyNotUniqueException,
                                                NoSuchRoleException

Remove a direct relationship between two roles, where the parent role is uniquely identified by the search criteria parentAttrName=parentAttrValue and the child role is uniquely identified by the search criteria childAttrName=childAttrValue.

Parameters:: parentAttrName - The parent role attribute name for the search criteria.; parentAttrValue - The parent role attribute value for the search criteria.; childAttrName - The child role attribute name for the search criteria.; childAttrValue - The child role attribute value for the search criteria.
Returns:: RoleManagerResult containing the status of the operation.
Throws:: ValidationFailedException - if the validation during the orchestration process fails.; AccessDeniedException - if the logged-in user does not have the required authorization.; RoleRelationshipRemoveException - If operation fails.; SearchKeyNotUniqueException - if there is more than one roles for the given search criteria.; NoSuchRoleException - if the role with given search criteria is not found.

updateRoleRelationship

RoleManagerResult updateRoleRelationship(java.lang.String parentAttrName,
                                         java.lang.Object parentAttrValue,
                                         java.lang.String childAttrName,
                                         java.lang.Object childAttrValue,
                                         java.util.Map args)
                                         throws ValidationFailedException,
                                                AccessDeniedException,
                                                RoleRelationshipUpdateException,
                                                NoSuchRoleRelationshipException,
                                                SearchKeyNotUniqueException,
                                                NoSuchRoleException

Update a relationship between two roles, where the parent role is uniquely identified by the search criteria parentAttrName=parentAttrValue and the child role is uniquely identified by the search criteria childAttrName=childAttrValue.

Parameters:: parentAttrName - The parent role attribute name for the search criteria.; parentAttrValue - The parent role attribute value for the search criteria.; childAttrName - The child role attribute name for the search criteria.; childAttrValue - The child role attribute value for the search criteria.; args - The attributes and values to update the role relationship with.
Returns:: RoleManagerResult containing the status of the operation.
Throws:: ValidationFailedException - if the validation during the orchestration process fails.; AccessDeniedException - if the logged-in user does not have the required authorization.; RoleRelationshipUpdateException - If operation fails.; NoSuchRoleRelationshipException - If the relationship doesn't exist.; SearchKeyNotUniqueException - if there is more than one roles for the given search criteria.; NoSuchRoleException - if the role with given search criteria is not found.

getUserMembershipRule

SearchRule getUserMembershipRule(java.lang.String roleKey)
                                 throws AccessDeniedException,
                                        NoSuchRoleException,
                                        RoleLookupException

Returns the user membership rule for the specified Role

Parameters:: roleKey - The id of the role whose details are required.
Returns:: SearchRule contains the user membershp rule for this role
Throws:: AccessDeniedException - if the logged-in user does not have the required authorization.; RoleLookupException - if there is an exception while doing the search.; NoSuchRoleException - if the role with given key is not found.
Since:: 11gps2

setUserMembershipRule

RoleManagerResult setUserMembershipRule(java.lang.String roleKey,
                                        SearchRule userMembershipRule)
                                        throws ValidationFailedException,
                                               AccessDeniedException,
                                               RoleModifyException,
                                               NoSuchRoleException

Sets the user membership rule on the specified Role

Parameters:: roleKey - The key of the role who's details are required.; userMembershipRule - User membership rule to set for this role
Returns:: RoleManagerResult containing the status of the operation.
Throws:: ValidationFailedException - if the validation during the orchestration process fails.; AccessDeniedException - if the logged-in user does not have the required authorization.; RoleModifyException - if the orchestration fails for modify operation.; NoSuchRoleException - if the role with given key is not found.
Since:: 11gps2

setUserMembershipRule

RoleManagerResult setUserMembershipRule(java.lang.String roleKey,
                                        SearchRule userMembershipRule,
                                        boolean evaluateMembershipLater)
                                        throws ValidationFailedException,
                                               AccessDeniedException,
                                               RoleModifyException,
                                               NoSuchRoleException

Sets the user membership rule on the specified Role and membership is evaluated later if evaluateMembershipLater is passed as TRUE

Parameters:: roleKey - The key of the role who's details are required.; userMembershipRule - User membership rule to set for this role; evaluateMembershipLater - if TRUE Membership is evaluated later. FALSE it is evaluated immediately in post process handler.
Throws:: ValidationFailedException - if the validation during the orchestration process fails.; AccessDeniedException - if the logged-in user does not have the required authorization.; RoleModifyException - if the orchestration fails for modify operation.; NoSuchRoleException - if the role with given key is not found.

previewDynamicUserMembership

java.util.List previewDynamicUserMembership(java.lang.String roleKey,
                                            SearchRule userMembershipRule,
                                            java.util.Set retAttrs,
                                            java.util.Map configParams)
                                            throws ValidationFailedException,
                                                   AccessDeniedException,
                                                   RoleMemberException

Preview the user membership rule

Parameters:

roleKey - the key of the role for which we want to preview the members

userMembershipRule - User membership rule to preview

retAttrs - The attributes to lookup.

configParams - Parameters to further configure the search operation. There are four configuration parameters. STARTROW, ENDROW, SORTEDBY and SORTORDER.

The STARTROW and ENDROW search configuration parameters indicates which subset of the complete search result is to be fetched.

The SORTEDBY search configuration parameter indicates the attribute on which search result is to be sorted. This parameter is optional and is set to Display Name by default.

Returns:

the list of users that match the membership rule

Throws:

ValidationFailedException - if the rule is syntactically incorrect.

AccessDeniedException - if the logged-in user does not have the required authorization.

RoleMemberException - If operation fails.

Since:

11gps2

grantRole

RoleManagerResult grantRole(java.lang.String roleAttributeName,
                            java.lang.Object roleAttributeValue,
                            java.lang.String userAttributeName,
                            java.lang.Object userAttributeValue,
                            java.util.Map relationshipAttrs)
                            throws ValidationFailedException,
                                   AccessDeniedException,
                                   RoleGrantException,
                                   SearchKeyNotUniqueException,
                                   NoSuchRoleException,
                                   NoSuchUserException

Grant the role uniquely identified by the search criteria roleAttributeName=roleAttributeValue to the specified user uniquely identified by the search criteria userAttributeName=userAttributeValue.

Parameters:: roleAttributeName - The role attribute name for the search criteria.; roleAttributeValue - The role attribute value for the search criteria.; userAttributeName - The user attribute name for the search criteria.; userAttributeValue - The user attribute value for the search criteria.; relationshipAttrs - Map containing following keys: startDate - Date on which Role should be auto-granted to User. If null role is granted immediately. endDate - Date on which Role should be auto-revoked from User. if null role is never revoked. The dates are assumed to be in server timezone.
Returns:: RoleManagerResult containing the set of success and failure results. Each failure result has a reason for failure associated with it.
Throws:: ValidationFailedException - if the validation during the orchestration process fails.; AccessDeniedException - if the logged-in user does not have the required. authorization.; RoleGrantException - If operation fails.; SearchKeyNotUniqueException - if there is more than one roles or users for the given search criteria.; NoSuchRoleException - if the role with given search criteria is not found.; NoSuchUserException - if the user with given search criteria is not found.

grantRole

RoleManagerResult grantRole(java.lang.String roleKey,
                            java.util.Set userKeys,
                            java.util.Map relationshipAttrs)
                            throws ValidationFailedException,
                                   AccessDeniedException,
                                   RoleGrantException

Grant the role identified by roleKey to the specified user/s.

Parameters:: roleKey - The key of the role to be granted.; userKeys - The keys of the user to whom to grant the role.; relationshipAttrs - Map containing following keys: startDate - Date on which Role should be auto-granted to User. If null role is granted immediately. endDate - Date on which Role should be auto-revoked from User. if null role is never revoked. The dates are assumed to be in server timezone.
Returns:: RoleManagerResult containing the set of success and failure results. Each failure result has a reason for failure associated with it.
Throws:: ValidationFailedException - if the validation during the orchestration process fails.; AccessDeniedException - if the logged-in user does not have the required authorization.; RoleGrantException - If operation fails.

grantRole

RoleManagerResult grantRole(java.lang.String roleKey,
                            java.util.List userKeys,
                            java.util.List relationshipAttrs)
                            throws ValidationFailedException,
                                   AccessDeniedException,
                                   RoleGrantException

Grant the role identified by roleKey to the specified user/s.

Parameters:: roleKey - The key of the role to be granted.; userKeys - The keys of the user to whom to grant the role.; relationshipAttrsList - List of map - one for each user. Map containing following keys: startDate - Date on which Role should be auto-granted to User. If null role is granted immediately. endDate - Date on which Role should be auto-revoked from User. if null role is never revoked. The dates are assumed to be in server timezone.
Returns:: RoleManagerResult containing the set of success and failure results. Each failure result has a reason for failure associated with it.
Throws:: ValidationFailedException - if the validation during the orchestration process fails.; AccessDeniedException - if the logged-in user does not have the required authorization.; RoleGrantException - If operation fails.

grantRole

RoleManagerResult grantRole(java.lang.String roleKey,
                            java.util.Set userKeys,
                            java.util.Map relationshipAttrs,
                            boolean evaluatePolicies)
                            throws ValidationFailedException,
                                   AccessDeniedException,
                                   RoleGrantException

Grant the role identified by roleKey to the specified user/s.

Parameters:: roleKey - The key of the role to be granted.; userKeys - The keys of the user to whom to grant the role.; relationshipAttrs - Map containing following keys: startDate - Date on which Role should be auto-granted to User. If null role is granted immediately. endDate - Date on which Role should be auto-revoked from User. if null role is never revoked. The dates are assumed to be in server timezone.; evaluatePolicies - Boolean to indicate whether to evaluate policies or not when user is granted to the role
Returns:: RoleManagerResult containing the set of success and failure results. Each failure result has a reason for failure associated with it.
Throws:: ValidationFailedException - if the validation during the orchestration process fails.; AccessDeniedException - if the logged-in user does not have the required authorization.; RoleGrantException - If operation fails.

grantRoleRequest

java.lang.String grantRoleRequest(java.lang.String roleAttributeName,
                                  java.lang.Object roleAttributeValue,
                                  java.lang.String userAttributeName,
                                  java.lang.Object userAttributeValue,
                                  java.util.Map relationshipAttrs)
                                  throws ValidationFailedException,
                                         AccessDeniedException,
                                         RoleGrantException,
                                         SearchKeyNotUniqueException,
                                         NoSuchRoleException,
                                         NoSuchUserException

Raises a request to grant the role uniquely identified by the search criteria roleAttributeName=roleAttributeValue to the specified user uniquely identified by the search criteria userAttributeName=userAttributeValue.

Parameters:: roleAttributeName - The role attribute name for the search criteria.; roleAttributeValue - The role attribute value for the search criteria.; userAttributeName - The user attribute name for the search criteria.; userAttributeValue - The user attribute value for the search criteria.; relationshipAttrs - Map containing following keys: startDate - Date on which Role should be auto-granted to User. If null role is granted immediately. endDate - Date on which Role should be auto-revoked from User. if null role is never revoked. The dates are assumed to be in server timezone.
Returns:: The id of the reuest.
Throws:: ValidationFailedException - if the validation fails during the request creation.; AccessDeniedException - if the logged-in user does not have the required. authorization.; RoleGrantException - If request creation fails.; SearchKeyNotUniqueException - if there is more than one roles or users for the given search criteria.; NoSuchRoleException - if the role with given search criteria is not found.; NoSuchUserException - if the user with given search criteria is not found.

grantRoleRequest

java.lang.String grantRoleRequest(java.lang.String roleKey,
                                  java.util.Set userKeys,
                                  java.util.Map relationshipAttrs)
                                  throws ValidationFailedException,
                                         AccessDeniedException,
                                         RoleGrantException

Raises a request to grant the role identified by roleKey to the specified user/s.

Parameters:: roleKey - The key of the role to be granted.; userKeys - The keys of the user to whom to grant the role.; relationshipAttrs - Map containing following keys: startDate - Date on which Role should be auto-granted to User. If null role is granted immediately. endDate - Date on which Role should be auto-revoked from User. if null role is never revoked. The dates are assumed to be in server timezone.
Returns:: The id of the request.
Throws:: ValidationFailedException - if the validation fails during the request creation.; AccessDeniedException - if the logged-in user does not have the required authorization.; RoleGrantException - If request creation fails.

grantRoleRequest

java.lang.String grantRoleRequest(java.lang.String roleKey,
                                  java.util.List userKeys,
                                  java.util.List relationshipAttrs)
                                  throws ValidationFailedException,
                                         AccessDeniedException,
                                         RoleGrantException

Raises a request to grant the role identified by roleKey to the specified user/s.

Parameters:: roleKey - The key of the role to be granted.; userKeys - The keys of the user to whom to grant the role.; relationshipAttrs - Map containing following keys: startDate - Date on which Role should be auto-granted to User. If null role is granted immediately. endDate - Date on which Role should be auto-revoked from User. if null role is never revoked. The dates are assumed to be in server timezone. The list is assumed to contain one map entry for each user in userKeys. If the map entries do not match the number of users, then dates will be assumed null for them.
Returns:: The id of the request.
Throws:: ValidationFailedException - if the validation fails during the request creation.; AccessDeniedException - if the logged-in user does not have the required authorization.; RoleGrantException - If request creation fails.

grantRoles

RoleManagerResult grantRoles(java.lang.String userKey,
                             java.util.Set roleKeys,
                             java.util.Map relationshipAttrs)
                             throws ValidationFailedException,
                                    AccessDeniedException,
                                    RoleGrantException

Grant the roles identified by roleKeys to the specified user.

Parameters:: userKey - The key of the user to whom to grant the roles.; roleKeys - The keys of roles to be granted.; relationshipAttrs - Map containing following keys: startDate - Date on which Role should be auto-granted to User. If null role is granted immediately. endDate - Date on which Role should be auto-revoked from User. if null role is never revoked. The dates are assumed to be in server timezone.
Returns:: RoleManagerResult containing the set of success and failure results. Each failure result has a reason for failure associated with it.
Throws:: ValidationFailedException - if the validation during the orchestration process fails.; AccessDeniedException - if the logged-in user does not have the required authorization.; RoleGrantException - If operation fails.

grantRolesRequest

java.lang.String grantRolesRequest(java.lang.String userKey,
                                   java.util.Set roleKeys,
                                   java.util.Map relationshipAttrs)
                                   throws ValidationFailedException,
                                          AccessDeniedException,
                                          RoleGrantException

Raises a request to grant the roles identified by roleKeys to the specified user.

Parameters:: userKey - The key of the user to whom to grant the roles.; roleKeys - The keys of roles to be granted.; relationshipAttrs - Map containing following keys: startDate - Date on which Role should be auto-granted to User. If null role is granted immediately. endDate - Date on which Role should be auto-revoked from User. if null role is never revoked. The dates are assumed to be in server timezone.
Returns:: The id of the request.
Throws:: ValidationFailedException - if the validation fails during the request creation.; AccessDeniedException - if the logged-in user does not have the required authorization.; RoleGrantException - If request creation fails.

getPendingRoleUserRelationshipAttributes

Relationship getPendingRoleUserRelationshipAttributes(java.lang.String roleKey,
                                                      java.lang.String userKey,
                                                      java.util.Set retAttrs)
                                                      throws AccessDeniedException,
                                                             NoSuchRoleGrantException,
                                                             RoleGrantLookupException

Lookup the attributes of a pending role grant.

Parameters:: roleKey - The key of the role whose grant we are looking up.; userKey - The key of the user whose grant we are looking up.; retAttrs - The attributes to lookup.
Returns:: Relationship containing the attributes of the role grant.
Throws:: ValidationFailedException - if the validation during the orchestration process fails.; AccessDeniedException - if the logged-in user does not have the required authorization.; RoleGrantLookupException - If operation fails.; NoSuchRoleGrantException - If the grant doesn't exist

setPendingRoleUserRelationshipAttributes

RoleManagerResult setPendingRoleUserRelationshipAttributes(java.lang.String roleKey,
                                                           java.lang.String userKey,
                                                           java.util.Map relationshipAttrs)
                                                           throws ValidationFailedException,
                                                                  AccessDeniedException,
                                                                  RoleGrantUpdateException,
                                                                  NoSuchRoleGrantException

Update the attributes of a pending role grant.

Parameters:: roleKey - The key of the role whose grant we are updating.; userKey - The key of the user whose grant we are updating.; relationshipAttrs - The attributes and values to update the pending role grant relationship with.
Returns:: RoleManagerResult containing the status of the operation.
Throws:: ValidationFailedException - if the validation during the orchestration process fails.; AccessDeniedException - if the logged-in user does not have the required authorization.; RoleGrantUpdateException - If operation fails.; NoSuchRoleGrantException - If the role grant doesn't exist

setPendingRoleUserRelationshipAttributesRequest

java.lang.String setPendingRoleUserRelationshipAttributesRequest(java.lang.String roleKey,
                                                                 java.lang.String userKey,
                                                                 java.util.Map relationshipAttrs)
                                                                 throws ValidationFailedException,
                                                                        AccessDeniedException,
                                                                        RoleGrantException,
                                                                        NoSuchRoleGrantException

Submits a request to update the attributes of a pending role grant.

Parameters:: roleKey - The key of the role whose grant we are updating.; userKey - The key of the user whose grant we are updating.; relationshipAttrs - The attributes and values to update the pending role grant relationship with.
Returns:: RoleManagerResult containing the status of the operation.
Throws:: ValidationFailedException - if the validation during the orchestration process fails.; AccessDeniedException - if the logged-in user does not have the required authorization.; RoleGrantUpdateException - If operation fails.; NoSuchRoleGrantException - If the role grant doesn't exist; RoleGrantException

isPendingRoleGrant

boolean isPendingRoleGrant(java.lang.String roleKey,
                           java.lang.String userKey)
                           throws AccessDeniedException,
                                  UserMembershipException

Return true if the user has the role granted in pending state.

Parameters:: roleKey - The key of the role whose memberships we are looking up.; userKey - The key of the user whose memberships we are looking up.
Returns:: true if the user does not have the role granted and the grant is in pending state waiting for the startDate.
Throws:: AccessDeniedException - if the logged-in user does not have the required authorization.; UserMembershipException - If operation fails.

searchRoleHistory

java.util.List searchRoleHistory(java.lang.String roleKey,
                                 RoleManagerConstants.RoleHistoryType type,
                                 SearchCriteria criteria,
                                 java.util.Set retAttrs,
                                 java.util.Map configParams)
                                 throws AccessDeniedException,
                                        RoleManagerException

Search the role history for specific audit events/types of audit events.

Parameters:: roleKey - Role key; type - Type of History to be fetched; criteria - The criteria can be used to filter the type of history you want; retAttrs - List of attribute the search should return.; configParams - Parameters to further configure the search operation. There are two configuration parameters. STARTROW, and ENDROW The STARTROW and ENDROW search configuration parameters indicates which subset of the complete search result is to be fetched.
Returns:: list of AuditEvents matching the search criteria.
Throws:: AccessDeniedException; RoleManagerException

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

oracle.iam.identity.rolemgmt.api Interface RoleManager

create

createRequest

modify

modifyRequest

modify

modifyRequest

delete

deleteRequest

modify

modifyRequest

delete

deleteRequest

delete

deleteRequest

getDetails

getDetails

getSimilarRoles

search

getDetails

grantRole

grantRoleRequest

grantRole

revokeRoleGrant

revokeRoleGrantRequest

revokeRoleGrant

getRoleGrantDetails

grantRoles

grantRolesRequest

revokeRoleGrants

revokeRoleGrantsRequest

updateRoleGrant

getRoleMembers

getDynamicRoleMembers

getDynamicRoleMembers

getRoleMembers

getPendingUserGrants

getPendingRoleGrants

getRoleIndirectMembers

getUnassignedRoleMembers

getUnassignedRoleMembers

isRoleGranted

isRoleDynamicallyGranted

getUserMemberships

getUserMemberships

getUserRoleGrants

getUnassignedUserMemberships

addRoleRelationship

removeRoleRelationship

getRoleRelationshipDetails

updateRoleRelationship

getRoleChildren

getDirectRoleChildren

isRoleParent

getRoleParents

getDirectRoleParents

updateEntityDefinition

grantRole

grantRoleRequest

getRoleGrantDetails

updateRoleGrant

revokeRoleGrant

revokeRoleGrantRequest

getRoleRelationshipDetails

addRoleRelationship

removeRoleRelationship

updateRoleRelationship

getUserMembershipRule

setUserMembershipRule

setUserMembershipRule

previewDynamicUserMembership

grantRole

grantRole

grantRole

grantRole

grantRoleRequest

grantRoleRequest

grantRoleRequest

grantRoles

grantRolesRequest

oracle.iam.identity.rolemgmt.api
Interface RoleManager