Skip navigation links

oracle.iam.request.api
Interface UnauthenticatedRequestService

public interface UnauthenticatedRequestService

This service is used for submission and tracking of requests that doesn't require authentication.
Example: Self Registration.

Method Summary

oracle.iam.request.model.vo.RequestModel	getModel(java.lang.String model) Get the request model given model name
RequestStatusSummary[]	getRequestStatusSummary(java.lang.String reqId) Get an array of status changes of a given request.
oracle.iam.request.dataset.vo.RequestDataSet	getRestrictedDataSet(java.lang.String templateName, java.lang.String entitySubType) Get the restricted data set that is associated with the given template for the given entity.
RequestTemplate	getTemplate(java.lang.String templateName) Get the template given a name.
java.util.List	getTemplateNames() Get the list of template names that need no authentication.
java.lang.String	submitRequest(RequestData requestData) Submit a request for an unauthenticated user Once the target entities and beneficiaries are added, this API should be called.

Method Detail

getTemplateNames

java.util.List getTemplateNames()
                                throws RequestServiceException

Get the list of template names that need no authentication.

Returns:

List of template names for unauthenticated request type

Throws:

RequestServiceException - if search fails

getTemplate

RequestTemplate getTemplate(java.lang.String templateName)
                            throws RequestServiceException

Get the template given a name.

Parameters:

templateName - - name of the template

Returns:

RequestTemplate template object given a name

Throws:

RequestServiceException - - if the template requires authentication or in case of an error while getting the template

getModel

oracle.iam.request.model.vo.RequestModel getModel(java.lang.String model)
                                                  throws RequestServiceException

Get the request model given model name

Parameters:

model - - name of the request type/model

Returns:

RequestModel request model object with given name

Throws:

RequestServiceException - - if the model requires authentication or in case of an error while getting the model.

getRestrictedDataSet

oracle.iam.request.dataset.vo.RequestDataSet getRestrictedDataSet(java.lang.String templateName,
                                                                  java.lang.String entitySubType)
                                                                  throws RequestServiceException

Get the restricted data set that is associated with the given template for the given entity.

Parameters:

templateName - - name of the template.

entitySubType - - Name of the entity sub type for generic entities like "Resource". Can be null for non-generic entities like "User".

Returns:

restricted data set.

Throws:

RequestServiceException - if data validation or search fails

submitRequest

java.lang.String submitRequest(RequestData requestData)
                               throws InvalidRequestException,
                                      InvalidRequestDataException,
                                      RequestServiceException,
                                      BulkBeneficiariesAddException,
                                      BulkEntitiesAddException

Submit a request for an unauthenticated user Once the target entities and beneficiaries are added, this API should be called. Call to this API initiates the approvals required, if any

Parameters:

requestData - RequestData object

Throws:

InvalidRequestException, - if requestData object is invalid

RequestServiceException - if request creation fails

InvalidRequestDataException - if data validation fails

BulkBeneficiariesAddException

BulkEntitiesAddException

InvalidRequestException

getRequestStatusSummary

RequestStatusSummary[] getRequestStatusSummary(java.lang.String reqId)
                                               throws RequestServiceException

Get an array of status changes of a given request.

Parameters:

reqId, - Id of the request

Returns:

RequestStatusSummary[] an array of RequestStatusSummary value objects. This value object contains the status, date and time at which request achieved this status and the date and time at which the request is submitted. Current status of the request is at the first element of array

Throws:

RequestServiceException - if search fails

Skip navigation links