Jump to

• Request
• Response
• Examples

Trigger roles autoprovisioning process

post

/hcmRestApi/resources/11.13.18.05/userAccounts/{GUID}/action/autoprovisionRoles

Triggers the roles autoprovisioning process on the selected user account.

Request

Path Parameters

• GUID(required): string
  Globally unique identifier for the user account.

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

• processImmediateFlag: boolean
  Indicates whether the roles autoprovisioning process is triggerred immediately or deferred. The default value is Yes. Valid values are Y and N.

{
    "type":"object",
    "properties":{
        "processImmediateFlag":{
            "type":"boolean",
            "description":"Indicates whether the roles autoprovisioning process is triggerred immediately or deferred. The default value is Yes. Valid values are Y and N.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

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
  Success or error message.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"Success or error message."
        }
    },
    "additionalProperties":false
}

Back to Top

Examples

The following example shows how to trigger the roles autoprovisioning process on the selected user account by submitting a POST request on the REST resource using cURL.

curl -i -u "<user>:<password>" -H "Content-Type: application/vnd.oracle.adf.action+json" -X POST -d <payload> https://host:port/hcmRestApi/resources/11.13.18.05/userAccounts/<userGuid>/action/autoprovisionRoles

Example of Payload

The following shows an example of the payload.

{
  "processImmediateFlag": true
}

Example of Response Header

The following is an example of the response header.

Status: HTTP/1.1 200 OK

Content-Type: application/vnd.oracle.actionresult+json

Example of Response Body

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

    {
        "result": "Success"
    }

Back to Top