Operation-Specific Configuration Parameters

Enables configuration using cURL command.

Note
You can configure an operation using cURL Command or through the Context URL, Method, Header, and Body. While configuring an operation through the cURL Command, the Context URL, Method, Header and Body operation-specific parameters are not accessible.

The endpoint cURL command for an operation which contains the complete request URL, Method, Header, and Body is provided in the following example:

curl --location --request POST 'https://api.dropbox.com/2/team/members/list' \
--header 'Authorization: $application.accesstoken$' \
--header 'Content-Type: application/json' \
--data-raw '{"limit":1}'

• The complete request URL:

  https://api.dropbox.com/2/team/members/list

  Note
  The URL must be in http:// or https:// format. You can add a placeholder URL, but it must have http:// or https:// in the beginning of the URL string. You can't use a placeholder URL on its own.

• The Method: POST

  --header 'Authorization: $application.accesstoken$' \

  --header 'Content-Type: application/json' \

• Header is labeled

• Body:

  --data-raw '{"limit":1}'

Context URL specific to the operation.

For example:

/api/core/v3/securityGroups?startIndex=0&count=100&fields=%40all&sort=lastNameAsc

The following are the keywords that are used in the Context URL along with the placeholder, $:

• plan

• response

• application

• getobject

• authenticate

For more information on the Keywords, refer to Keywords.

Select one of the following types of HTTP method supported by the respective operation:

• GET

• PUT

• POST

• DELETE

• PATCH

(Optional) To view the header value in plain text, you must provide it in encrypted form. The encrypted value can be obtained from the IdentityIQ Console.

The following example displays the sample header key and header value:

Authorization 1:vQaPY5LvJVbpsaig0nE56Q==

where:

• Header Key – Authorization

• Header Value – 1:vQaPY5LvJVbpsaig0nE56Q==

Standard HTTP body used to post data with request. You can send data in either of the following format:

• form-data – (Applicable only for JSON) Key value. You must set the data that has to pass in the key value

• raw – Data to be sent in request body.

For endpoint configuration, user must provide the XML payload by selecting the raw format.

For example:

{  
"limit": 10,
"cursor": "abcd1234"
}

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:bsvc="urn:com.workday/bsvc">   
 <soapenv:Header>
 <Security xmlns=
 "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
 ...
 </Security>
 </soapenv:Header>
 <soapenv:Body>
 ...
 </soapenv:Body>
</soapenv:Envelope>

The following keywords are used in the Body along with the placeholder, $:

• plan

• response

• application

• getobject

• authenticate

Handling '$' Character In the URL and the Body

The Web Services connector extracts and handles the $ character, in the URL and body, along with the placeholders.

The following table provides the details of the placeholder:

{
    "type": "$plan.type$",
    "id": "$plan.nativeIdentity$",
    "title": "$plan.title$",
    "externalid": "12345"
}

{ 
    "type": "student", 
    "id": "STUD121",
    "externalid": "12345"
}

<worker>
    <fname>$plan.type$</fname>
    <lname>$plan.type$</lname>
    <wid>$plan.nativeIdentity$</wid>
    <description> permanent worker</description>
</worker>

<worker>
    <fname>John</fname>
    <lname></lname>      <--null value
    <wid>wid121</wid>
    <description> permanent worker</description>
</worker>

Escape Characters in the Body of a SOAP Request

You can use the following format for escaping a characters used for request/XML syntax:

<![CDATA[*+_value_+*]]>

For example, <![CDATA[CC&amp;SD]]> results in "CC&SD".

The character set, "&" produces an ampersand (&) in the output. If you were to use a literal ampersand in the request without escaping the character, it might cause errors.

(For XML Web Services) XPath Namespace Mapping – XML Namespace Prefix and the corresponding Namespace URL identify uniquely named elements and attributes in the XML request/response.

If there exists any non-standard XML Namespace in the response, configure it in the XML Namespace mapping where the key is Namespace Prefix and value is the Namespace URL.

Note
The absence of non-standard XML Namespaces results in errors while parsing responses.

If a default Namespace is present, add a temporary Namespace Prefix with the default Namespace URL in the XML Namespace mappings. Use this temporary prefix in the XPATH elements within the scope of the default Namespace.

For example, refer to Example 1: XML response for mapping the payload in XML Response Configuration.

Root Path – Common path present in the JSON/XML response. The root path must be common for all the above attributes mentioned in the Response Attribute Mapping. Default: $

For example:

• For JSON – $.members.profile

• For XML – //wd:Response_Data/wd:Worker/wd:Worker_Data

Successful Response Code – Successful response code expected by the respective Web Service operation.

This field accepts HTTP status code in .csv format (For example, 200, 201, 203).

If the list does not contain any value, the status codes from 200 to 299 are checked.

There could be a situation where successful status code may start with 2; in this situation you can provide 2**.

Before Operation Rule – Rule that invokes before performing any operation such as account aggregation, enable account, or disable account.

After Operation Rule – Rule that invokes after performing any operation such as account aggregation, enable account, or disable account.

(Applicable only for operations of type aggregation and get object)

Provide the parent endpoint name for endpoint chaining. If multiple endpoints of the same operation type exist and there are no parent endpoint configuration provided, then each endpoint behaves as an independent endpoint.