Oracle HCM Cloud Authenticate an Element Instance

You can authenticate with Oracle HCM Cloud to create your own instance of the Oracle HCM Cloud element through the UI or through APIs. Once authenticated, you can use the element instance to access the different functionality offered by the Oracle HCM Cloud platform.

Authenticate through the UI

Use the UI to authenticate with Oracle HCM Cloud and create an element instance as described in Authenticate an element Instance (UI). You will need your Username, Password, and Server URL that you identified in API Provider Setup.

Authenticate through the API

Authenticating through the API is similar to authenticating via UI. Instead of clicking and typing through a series of buttons, text boxes and menus, you will instead send a request to our /instances endpoint. The end result is the same though: an authenticated element instance with a token and id.

To authenticate an element instance:

Construct a JSON body as shown below (see Parameters):

{
  "element": {
    "key": "oraclehcmcloud"
  },
  "configuration": {
    "username": "xxxxxxxxxx",
    "password": "xxxxxxxxxx",
    "siteAddress": "<ORACLE_HCM_CLOUD_URL>"
  },
  "tags": [
    "<Add_Your_Tag>"
  ],
  "name": "<INSTANCE_NAME>"
}

Call the following, including the JSON body you constructed in the previous step:
```
POST /instances
```
Note: Make sure that you include the User and Organization keys in the header. For more information, see Authorization Headers, Organization Secret, and User Secret.
Locate the token and id in the response and save them for all future requests using the element instance.

Example cURL

curl -X POST \
  https://api.cloud-elements.com/elements/api-v2/instances \
  -H 'authorization: User <XXXXXXXXXXXXXXXXX>, Organization <XXXXXXXXXXXXXXXXX>' \
  -H 'content-type: application/json' \
  -d '{
  "element": {
    "key": "oraclehcmcloud"
  },
  "configuration": {
    "username": "xxxxxxxxxxxxxxxxxx",
    "password": "xxxxxxxxxxxxxxxxxxxxxxxx",
    "siteAddress": "https://adc3-zeam-fa-ext.oracledemos.com"
  },
  "tags": [
    "Docs"
  ],
  "name": "API Instance"
}'

Parameters

API parameters not shown in Cloud Elements are in code formatting.

Note: Event related parameters are described in Events.

Parameter	Description	Data Type
`key`	The element key. oraclehcmcloud	string
Name `name`	The name of the element instance created during authentication.	string
Username `crm.autotask.username`	The Oracle HCM Cloud Username.	string
Password `crm.autotask.password`	The Oracle HCM Cloud Password.	string
Server URL `crm.autotask.server.url`	The Oracle HCM Cloud login URL.	string
tags	Optional. User-defined tags to further identify the instance.	string

Example Response for an Authenticated Instance

In this example, the instance ID is 12345 and the instance token starts with "ABC/D...". The actual values returned to you will be unique: make sure you save them for future requests to this new instance.

{
  "id": 12345,
  "name": "API Instance",
  "createdDate": "2017-08-07T18:46:38Z",
  "token": "ABC/Dxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "element": {
    "id": 123,
    "name": "Oracle HCM Cloud",
    "hookName": "oraclehcm",
    "key": "oraclehcmcloud",
    "description": "Add an Oracle HCM Cloud Instance to connect your existing Oracle account to the HCM Cloud Hub, allowing you to manage your incidents, priorities, statuses, users, etc. across multiple HCM Elements. You will need your Oracle HCM Cloud account information to add an instance.",
    "image": "elements/oraclehcmcloud.svg",
    "active": true,
    "deleted": false,
    "typeOauth": false,
    "trialAccount": false,
    "configDescription": "If you do not have an oracle.com account, you can create one at <a href=\"http://www.oracle.com\" target=\"_blank\">Oracle HCM Signup</a>",
    "signupURL": "http://www.oracle.com",
    "defaultTransformations": [  ],
    "transformationsEnabled": true,
    "bulkDownloadEnabled": true,
    "bulkUploadEnabled": true,
    "cloneable": false,
    "extendable": true,
    "beta": false,
    "authentication": {
        "type": "basic"
    },
    "extended": false,
    "hub": "humancapital",
    "protocolType": "rest",
    "parameters": [],
    "private": false
    },
    "elementId": 123,
    "tags": [
      "Docs"
      ],
    "provisionInteractions": [  ],
    "valid": true,
    "disabled": false,
    "maxCacheSize": 0,
    "cacheTimeToLive": 0,
    "configuration": {    },
    "eventsEnabled": false,
    "traceLoggingEnabled": false,
    "cachingEnabled": false,
    "externalAuthentication": "none",
    "user": {
        "id": 12345
      }
}