Workday Authenticate a Connector

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

Authenticate Through the UI

Use the UI to authenticate with Workday and create a connector instance as described in Authenticate a Connector Instance (UI). In addition to the base authentication parameters, you will need to have the prerequisites and additional information listed in API Provider Setup.

After successfully authenticating, we give you several options for next steps. Make requests using the API docs associated with the instance, map the instance to a common resource, or use it in a formula template.

Authenticate Through API

Send a request to our /instances endpoint to authenticate a connector instance. When finished note the token and id.

To authenticate a connector instance:

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

{
  "element": {
    "key": "workday"
  },
  "configuration": {
    "username": "<INSERT_WORKDAY_USERNAME>",
    "password": "<INSERT_WORKDAY_PASSWORD>",
    "workday.hostname": "<INSERT_WORKDAY_HOSTNAME>",
    "workday.tenant": "<INSERT_WORKDAY_TENANT_NAME>",
    "workday.version": "<INSERT_WORKDAY_VERSION>",
    "workday.service": "<INSERT_WORKDAY_SERVICE>"
  },
  "tags": [
    "<INSERT_TAGS>"
  ],
  "name": "<INSERT_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 connector instance.

Example cURL

curl -X POST \
  https://api.openconnectors.us2.ext.hana.ondemand.com/elements/api-v2/instances \
  -H 'authorization: User <USER_SECRET>, Organization <ORGANIZATION_SECRET>' \
  -H 'content-type: application/json' \
  -d '{
  "element": {
    "key": "workday"
  },
  "configuration": {
    "username": "<INSERT_WORKDAY_USERNAME>",
    "password": "<INSERT_WORKDAY_PASSWORD>",
    "workday.hostname": "<INSERT_WORKDAY_HOSTNAME>",
    "workday.tenant": "<INSERT_WORKDAY_TENANT_NAME>",
    "workday.version": "<INSERT_WORKDAY_VERSION>",
    "workday.service": "<INSERT_WORKDAY_SERVICE>"
  },
  "tags": [
    "erp"
  ],
  "name": "API Instance"
}'

Parameters

API parameters not shown in SAP Open Connectors are in code formatting.

Parameter	Description	Data Type
`key`	The connector key workday	string
Name `name`	The name of the connector instance created during authentication	string
User name `username`	The user name for the Workday account	string
Password `password`	The password for the Workday account	string
Hostname `workday.hostname`	The hostname for the Workday account	string
Tenant name `workday.tenant`	The Tenant name for the Workday account	string
Version `workday.version`	The version of Workday used by the account	string
Service `workday.service`	The Workday service under which the Workday operation is categorized. This specifies the default service when using the generic /{objectName} APIs, allowing you to pass the operation name instead of the service$operation format.	string
tags	Optional. User-defined tags to further identify the instance.	string

Example Response for an Authenticated Connector 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":"2018-05-25T15:56:22Z",
  "token":"ABC/Dxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx=",
  "element":{
    "id":6315,
    "name":"Workday",
    "hookName":"Workday",
    "key":"workday",
    "description":"The API can be used to manipulate employee data and to generate reports in several formats.",
    "image":"elements/custom-element-default-logo.png",
    "active":false,
    "deleted":false,
    "typeOauth":false,
    "trialAccount":false,
    "resources":[  ],
    "transformationsEnabled":true,
    "bulkDownloadEnabled":true,
    "bulkUploadEnabled":true,
    "cloneable":true,
    "extendable":true,
    "beta":false,
    "authentication":{
      "type":"basic"
    },
    "extended":false,
    "useModelsForMetadata":true,
    "hub":"erp",
    "protocolType":"http",
    "parameters":[  ],
    "private":false
  },
  "elementId":7292,
  "tags":[
    "erp"
  ],
  "provisionInteractions":[

  ],
  "valid":true,
  "disabled":false,
  "maxCacheSize":0,
  "cacheTimeToLive":0,
  "configuration":{  },
  "eventsEnabled":false,
  "traceLoggingEnabled":false,
  "cachingEnabled":false,
  "externalAuthentication":"none",
  "user":{
    "id":123456,
    "emailAddress":"claude.elements@cloud-elements.com",
    "firstName":"Claude",
    "lastName":"Elements"
  }
}

SAP Open Connectors

Authenticate Through the UI

Authenticate Through API

Example cURL

Parameters

Example Response for an Authenticated Connector Instance

Related Information