Jump to

• Request
• Response
• Examples

Perform analysis

post

/fscmRestApi/resources/11.13.18.05/advancedControlsRolesProvisioning/action/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.

Request

Header Parameters

• Metadata-Context:
  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".
• REST-Framework-Version:
  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.

Supported Media Types

• application/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• provisioningInfo: object provisioningInfo
  Additional Properties Allowed: additionalProperties

  A comma-separated list of role codes and data access to evaluate against access controls. This list is in addition to the roles and data access a user already has. Data access elements that can be passed in and evaluated are BUSINESS_UNIT, LEDGER_SET, DATA_ACCESS_SET, ASSET_BOOK and REFERENCE_DATA_SET.
• userName: string
  Unique name as defined in the Security Console for each user.

{
    "type":"object",
    "properties":{
        "provisioningInfo":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            },
            "description":"A comma-separated list of role codes and data access to \nevaluate against access controls. This list is in addition to the roles and data access a user already has.\n\nData access elements that can be passed in and evaluated are BUSINESS_UNIT, LEDGER_SET, DATA_ACCESS_SET, ASSET_BOOK and REFERENCE_DATA_SET.",
            "nullable":true
        },
        "userName":{
            "type":"string",
            "description":"Unique name as defined in the Security Console for each\nuser.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : provisioningInfo

Type: object

Additional Properties Allowed

Show Source

• array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"string"
        }
    },
    "description":"A comma-separated list of role codes and data access to \nevaluate against access controls. This list is in addition to the roles and data access a user already has.\n\nData access elements that can be passed in and evaluated are BUSINESS_UNIT, LEDGER_SET, DATA_ACCESS_SET, ASSET_BOOK and REFERENCE_DATA_SET.",
    "nullable":true
}

A comma-separated list of role codes and data access to evaluate against access controls. This list is in addition to the roles and data access a user already has. Data access elements that can be passed in and evaluated are BUSINESS_UNIT, LEDGER_SET, DATA_ACCESS_SET, ASSET_BOOK and REFERENCE_DATA_SET.

Nested Schema : additionalProperties

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): string
  The unique ID used to track the status of the provisioning simulation request.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"The unique ID used to track the status of the provisioning simulation request."
        }
    },
    "additionalProperties":false
}

Back to Top

Examples

The following example shows how to do performance analysis by submitting a POST request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.action+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/advancedControlsRolesProvisioning/action/runUserProvisioningAnalysis

Example Request Payload

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

{
    "userName":"XYZ_ADMIN",
    "provisioningInfo": {
        "JOB_ROLE_1": [
            "BUSINESS_UNIT = Vision China",
            "BUSINESS_UNIT = Vision Italy",
            "LEDGER_SET = FR Ledger",
            "LEDGER_SET = Progress FR"
        ],
        "JOB_ROLE_2": [
            "LEDGER_SET = Progress FR",
            "ASSET_BOOK = ADB FEDERAL"
        ]
    }
}

Example Response Body

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

{
    "result": "1"
}

Back to Top