OIM 11gR2 PS3 Provisioning Request using API

Provisioning request in OIM 11gR2 PS3 can be made for following:

1. Application Instance
2. Entitlements
3. Roles

Below are the API usage of all the request operations. You can use this sample methods and modify accordingly for bulk operations.

Application Instance Provisioning Request

/**

* Requesting Application Instance. This method

* can be further modified to use for bulk action.

* @param args

*/

private String createApplicationRequest() throws Exception{

RequestBeneficiaryEntity requestEntity = new RequestBeneficiaryEntity();

requestEntity.setRequestEntityType(oracle.iam.platform.utils.vo.OIMType.ApplicationInstance); //Type of the Request

requestEntity.setEntitySubType("APP_INSTANCE_NAME"); //Name of the Application Instance

requestEntity.setEntityKey("APP_INSTANCE_KEY"); //Application instance key

requestEntity.setOperation(RequestConstants.MODEL_PROVISION_APPLICATION_INSTANCE_OPERATION); //Request operation type.

/**

* here in each RequestBeneficiaryEntityAttribute object we will

* be setting the request data

* FIELD_1,FIELD_2,FIELD_3 are the request data set filed label name and the "value" is the corresponding value.

*/

List<RequestBeneficiaryEntityAttribute> attrs = new ArrayList<RequestBeneficiaryEntityAttribute>();

RequestBeneficiaryEntityAttribute attr;

attr = new RequestBeneficiaryEntityAttribute("FIELD_1", "value", RequestBeneficiaryEntityAttribute.TYPE.String);

attrs.add(attr);

attr = new RequestBeneficiaryEntityAttribute("FIELD_2", "value", RequestBeneficiaryEntityAttribute.TYPE.String);

attrs.add(attr);

attr = new RequestBeneficiaryEntityAttribute("FIELD_3", "value", RequestBeneficiaryEntityAttribute.TYPE.String);

attrs.add(attr);

//Continue setting RequestBeneficiaryEntity

requestEntity.setEntityData(attrs);

//Adding RequestBeneficiaryEntity to List

List<RequestBeneficiaryEntity> entities = new ArrayList<RequestBeneficiaryEntity>();

entities.add(requestEntity);

//creating new Beneficiary

Beneficiary beneficiary = new Beneficiary();

beneficiary.setBeneficiaryKey("USR_KEY"); //set BeneficiaryKey as User key

beneficiary.setBeneficiaryType(Beneficiary.USER_BENEFICIARY); //set the type as user

beneficiary.setTargetEntities(entities); //set target entities as list of RequestBeneficiaryEntity

//Adding Beneficiary to List

List<Beneficiary> beneficiaries = new ArrayList<Beneficiary>();

beneficiaries.add(beneficiary);

//Creating new RequestData and set the Beneficiaries with List of Beneficiaries

RequestData requestData = new RequestData();

requestData.setBeneficiaries(beneficiaries);

/**

* getRequesterConnection() is a seperate method to create OIM connection.

*/

OIMClient oimClientObjReq = getRequesterConnection("REQUESTER_LOGIN_ID"); //create an OIM connection with requester's login

RequestService requestAPI = (RequestService)oimClientObjReq.getService(RequestService.class);

String requestId = requestAPI.submitRequest(requestData);

System.out.println("requestId: "+requestId);

return requestId;

}

Entitlement Provisioning Request

private String createEntitlementRequest() throws Exception{

/**

* Creating a new RequestBeneficiaryEntity object which

* will hold all the requested entitlement related data.

*/

RequestBeneficiaryEntity requestEntity = new RequestBeneficiaryEntity();

requestEntity.setRequestEntityType(oracle.iam.platform.utils.vo.OIMType.Entitlement); //Type of the Request

requestEntity.setEntitySubType("ENT_CODE"); //Name of the Entitlement

requestEntity.setEntityKey("ENT_LIST_KEY"); //Entitlement key

requestEntity.setOperation(RequestConstants.MODEL_PROVISION_ENTITLEMENT_OPERATION); //Request operation type.

//Adding RequestBeneficiaryEntity to List

List<RequestBeneficiaryEntity> entities = new ArrayList<RequestBeneficiaryEntity>();

entities.add(requestEntity);

//creating new Beneficiary

Beneficiary beneficiary = new Beneficiary();

beneficiary.setBeneficiaryKey("USR_KEY"); //set BeneficiaryKey as User key

beneficiary.setBeneficiaryType(Beneficiary.USER_BENEFICIARY); //set the type as user

beneficiary.setTargetEntities(entities); //set target entities as list of RequestBeneficiaryEntity

//Adding Beneficiary to List

List<Beneficiary> beneficiaries = new ArrayList<Beneficiary>();

beneficiaries.add(beneficiary);

//Creating new RequestData and set the Beneficiaries with List of Beneficiaries

RequestData requestData = new RequestData();

requestData.setBeneficiaries(beneficiaries);

/**

* getRequesterConnection() is a seperate method to create OIM connection.

*/

OIMClient oimClientObjReq = getRequesterConnection("REQUESTER_LOGIN_ID"); //create an OIM connection with requester's login

RequestService requestAPI = (RequestService)oimClientObjReq.getService(RequestService.class);

String requestId = requestAPI.submitRequest(requestData); //Return request ID

System.out.println("requestId: "+requestId);

return requestId;

}

Role Provisioning Request

private String createRoleRequest() throws Exception{

/**

* Creating a new RequestBeneficiaryEntity object which

* will hold all the requested Role related data.

*/

RequestBeneficiaryEntity requestEntity = new RequestBeneficiaryEntity();

requestEntity.setRequestEntityType(oracle.iam.platform.utils.vo.OIMType.Role); //Type of the Request

requestEntity.setEntitySubType("UGP_KEY"); //Name of the Role

requestEntity.setEntityKey("UGP_NAME"); //Role key

requestEntity.setOperation(RequestConstants.MODEL_ASSIGN_ROLES_OPERATION); //Request operation type.

//Adding RequestBeneficiaryEntity to List

List<RequestBeneficiaryEntity> entities = new ArrayList<RequestBeneficiaryEntity>();

entities.add(requestEntity);

//creating new Beneficiary

Beneficiary beneficiary = new Beneficiary();

beneficiary.setBeneficiaryKey("USR_KEY"); //set BeneficiaryKey as User key

beneficiary.setBeneficiaryType(Beneficiary.USER_BENEFICIARY); //set the type as user

beneficiary.setTargetEntities(entities); //set target entities as list of RequestBeneficiaryEntity

//Adding Beneficiary to List

List<Beneficiary> beneficiaries = new ArrayList<Beneficiary>();

beneficiaries.add(beneficiary);

//Creating new RequestData and set the Beneficiaries with List of Beneficiaries

RequestData requestData = new RequestData();

requestData.setBeneficiaries(beneficiaries);

/**

* getRequesterConnection() is a seperate method to create OIM connection.

*/

OIMClient oimClientObjReq = getRequesterConnection("REQUESTER_LOGIN_ID"); //create an OIM connection with requester's login

RequestService requestAPI = (RequestService)oimClientObjReq.getService(RequestService.class);

String requestId = requestAPI.submitRequest(requestData); //Return request ID

System.out.println("requestId: "+requestId);

return requestId;

}