Package 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.
Example: Self Registration.
-
Method Summary
Modifier and TypeMethodDescriptionGet the request model given model namegetRequestDataSet
(String modelName, String entitySubType) Get the unauthenticated data set that is associated with the given model for the given entity subtype.getRequestStatusSummary
(String reqId) Get an array of status changes of a given request.getRestrictedDataSet
(String templateName, String entitySubType) Deprecated.getTemplate
(String templateName) Deprecated.Deprecated.submitRequest
(RequestData requestData) Submit a request for an unauthenticated user Once the target entities and beneficiaries are added, this API should be called.
-
Method Details
-
getTemplateNames
Deprecated.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
Deprecated.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
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
@Deprecated RequestDataSet getRestrictedDataSet(String templateName, String entitySubType) throws RequestServiceException Deprecated.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
-
getRequestDataSet
RequestDataSet getRequestDataSet(String modelName, String entitySubType) throws RequestServiceException Get the unauthenticated data set that is associated with the given model for the given entity subtype.- Parameters:
modelName
- - name of the model.entitySubType
- - Name of the entity sub type for generic entities like "Resource". Can be null for non-generic entities like "User".- Returns:
- unauthenticated data set.
- Throws:
RequestServiceException
- if data validation or search fails
-
submitRequest
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:
RequestServiceException
- if request creation failsInvalidRequestDataException
- if data validation failsBulkBeneficiariesAddException
BulkEntitiesAddException
InvalidRequestException
-
getRequestStatusSummary
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
-