1. REST API for Oracle Fusion Cloud Risk Management
  2. Tasks
  3. Asynchronous Separation of Duties Simulations

Get all results

get

/fscmRestApi/resources/11.13.18.05/advancedControlsRolesProvisioning

Request

Query Parameters
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey: Finds all user provisioning analysis incidents for a particular provisioning request.
      Finder Variables:
      • getUserProvisioningAnalysisIncidents: Finds all results for a particular provisioning simulation request.
        Finder Variables:
        • requestId; integer; The unique ID for the provisioning simulation request.
    • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
    • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

      Example:
      self,canonical
    • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
    • The resource item payload will be filtered in order to contain only data (no links section, for example).
    • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
    • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

      Format: ?q=expression1;expression2

      You can use these queryable attributes to filter this collection resource using the q query parameter:
      • conflictingRole; string; The roles conflicting with the role to be assigned to the user, delimited by a pipe character.
      • controlId; integer; The ID of an access control.
      • controlName; string; The name of the access control.
      • incidentPath; string; The result path, represented as role display names leading to the privilege found to be in conflict with the requested role.
      • incidentPathCode; string; The result path, represented as role codes leading to the privilege found to be in conflict with the requested role.
      • inputRoleCode; string; The code of the role to be assigned to the user.
      • inputRoleName; string; The name of the role to be assigned to the user.
    • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
    Header Parameters
    • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
    • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

    There's no request body for this operation.

    Back to Top

    Response

    Supported Media Types

    Default Response

    The following table describes the default response for this task.
    Headers
    • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
    • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
    Body ()
    Root Schema : advancedControlsRolesProvisioning
    Type: object
    Show Source
    Nested Schema : Items
    Type: array
    Title: Items
    The items in the collection.
    Show Source
    Nested Schema : advancedControlsRolesProvisioning-item-response
    Type: object
    Show Source
    • Read Only: true
      Maximum Length: 256
      The roles conflicting with the role to be assigned to the user, delimited by a pipe character.
    • Read Only: true
      The ID of an access control.
    • Read Only: true
      Maximum Length: 256
      The name of the access control.
    • Read Only: true
      Maximum Length: 256
      The result path, represented as role display names leading to the privilege found to be in conflict with the requested role.
    • Read Only: true
      Maximum Length: 256
      The result path, represented as role codes leading to the privilege found to be in conflict with the requested role.
    • Read Only: true
      Maximum Length: 256
      The code of the role to be assigned to the user.
    • Read Only: true
      Maximum Length: 256
      The name of the role to be assigned to the user.
    • Links
    Links
    getRequestStatus
    Returns the status of the provisioning simulation request. When the status is Completed, call the Get all results action. This returns conflicts a user will have if the requested roles and data are granted. Results include the control ID and control name, the requested role and its incident path, as well as the roles it conflicts with.
    runUserProvisioningAnalysis
    Use this action to initiate a simulation of active access controls. No incidents are created from the use of this REST resource. The results produced by this resource are only a simulation.
    Back to Top

    Examples

    The following example shows how to retrieve all the results by submitting a GET request on the REST resource using cURL.

    curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourcecollection+json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/advancedControlsRolesProvisioning?finder=getUserProvisioningAnalysisIncidents;requestId=1

    Example Response Body

    The following example shows the contents of the response body in JSON format:

    {
    "items": [
        {
            "controlId": 86731,
            "controlName": "Enter journal and view risk",
            "inputRoleCode": "PROV_TEST_ROLE2",
            "inputRoleName": "Prov Test Role2",
            "incidentPath": "Enter Journal By Spreadsheet",
            "conflictingRole": "Prov Test Role1",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/advancedControlsRolesProvisioning/14",
                    "name": "advancedControlsRolesProvisioning",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/advancedControlsRolesProvisioning/14",
                    "name": "advancedControlsRolesProvisioning",
                    "kind": "item"
                }
            ]
        },
        {
            "controlId": 86731,
            "controlName": "Enter journal and view risk",
            "inputRoleCode": "PROV_TEST_ROLE2",
            "inputRoleName": "Prov Test Role2",
            "incidentPath": "Enter Journal By Spreadsheet",
            "conflictingRole": "Prov Test Role1|Prov Test Role4",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/advancedControlsRolesProvisioning/13",
                    "name": "advancedControlsRolesProvisioning",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/advancedControlsRolesProvisioning/13",
                    "name": "advancedControlsRolesProvisioning",
                    "kind": "item"
                }
            ]
        },
        ...
    ],

    "count": 25,
    "hasMore": true,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/advancedControlsRolesProvisioning",
            "name": "advancedControlsRolesProvisioning",
            "kind": "collection"
        },
        {
            "rel": "action",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/advancedControlsRolesProvisioning/action/getRequestStatus",
            "name": "getRequestStatus",
            "kind": "other"
        },
        {
            "rel": "action",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/advancedControlsRolesProvisioning/action/runUserProvisioningAnalysis",
            "name": "runUserProvisioningAnalysis",
            "kind": "other"
        }
    ]
}
    Back to Top