HTTP Operations
Once you have created the Web Services Source or Connector, you must create each individual HTTP Operation.
On the left side menu, select HTTP Operations.
Authenticate (Custom Authentication)
On the HTTP Operations panel, click Add Operation and set the Operation Type to Custom Authentication.
General Information
To set the Authenticate information:
- On the Authenticate panel, ensure that General Information is selected.
- Enter a unique Operation Name.
- Ensure the Operation Type is set to Custom Authentication.
- Enter the Context URL.
- Replace the BIUL instance https://ubuntu-elk:58082 with the actual BIUL server URL you want to configure the connector for.
- Ensure the HTTP Method is set to POST.
- Click Save.
Headers
To set the Headers information:
- On the Authenticate panel, select Headers.
- Complete the Key and Value fields.
- To add additional key and value information, click Add Another.
- When done, click Save.
Body
To set the Body information:
- On the Authenticate panel, select Body.
- Select Raw.
- Complete the Body information by entering the text as written below.
{"domain":"","dsDomain":"","dsID":0,"password":"$application.password$","username":"$application.username$"}
- Click Save.
Response Information
To set the Response Information:
- On the Authenticate panel, select Response Information.
- Set the Root Path and Success Codes.
- Click Save.
Response Mapping
To set the Response Mapping information:
- On the Authenticate panel, select Response Mapping.
- Save the token included in the response into a _CA variable for encrypted values.
- Click Save.
Test Connection
Here we arbitrarily decided to use Account Aggregation within the Test Connection.
On the HTTP Operations panel, click Add Operation and set the Operation Type to Test Connection.
General information
To set the Test Connection information:
- On the Test Connection panel, ensure that General Information is selected.
- Enter a unique Operation Name.
- Ensure the Operation Type is set to Test Connection.
- Enter the Context URL.
- Ensure the HTTP Method is set to GET.
- Click Save.
Headers
Headers must include the Access Token generated by Custom Authentication. All HTTP Operations will need the Authorization Header with the token value.
To set the Headers information:
- On the Test Connection panel, select Headers.
- Complete the Key and Value fields.
- To add additional key and value information, click Add Another.
- When done, click Save.
Response Information
To set the Response Information:
- On the Test Connection panel, select Response Information.
- Set the Root Path and Success Codes.
- Click Save.
Account Aggregation
General information
To set the Account Aggregation information:
- On the Account Aggregation panel, ensure that General Information is selected.
- Enter a unique Operation Name.
- Ensure the Operation Type is set to Account Aggregation.
- Enter the Context URL.
- Ensure the HTTP Method is set to GET.
- Click Save.
Headers
To set the Headers information:
- On the Account Aggregation panel, select Headers.
- Complete the Key and Value fields.
- To add additional key and value information, click Add Another.
- When done, click Save.
Response Information
To set the Response Information:
- On the Account Aggregation panel, select Response Information.
- Set the Root Path and Success Codes.
- Click Save.
Response Mapping
To set the Response Mapping information:
- On the Account Aggregation panel, select Response Mapping.
- Set a Schema Attribute and the Attribute Path.
- To add additional values, click Add Another.
- When done, click Save.
Role Aggregation
General information
To set the Role Aggregation information:
- On the Role Aggregation panel, ensure that General Information is selected.
- Enter a unique Operation Name.
- Ensure the Operation Type is set to Group Aggregation.
- Enter the Context URL.
- Ensure the HTTP Method is set to GET.
- Click Save.
Headers
To set the Headers information:
- On the Role Aggregation panel, select Headers.
- Complete the Key and Value fields.
- To add additional key and value information, click Add Another.
- When done, click Save.
Response Information
To set the Response Information:
- On the Role Aggregation panel, select Response Information.
- Set the Root Path and Success Codes.
- Click Save.
Response Mapping
To set the Response Mapping information:
- On the Role Aggregation panel, select Response Mapping.
- Set a Schema Attribute and the Attribute Path.
- To add additional values, click Add Another.
- When done, click Save.
Create Account
General information
To set the Create Account information:
- On the Create Account panel, ensure that General Information is selected.
- Enter a unique Operation Name.
- Ensure the Operation Type is set to Create Account.
- Enter the Context URL.
- Ensure the HTTP Method is set to POST.
- Click Save.
Headers
To set the Headers information:
- On the Create Account panel, select Headers.
- Complete the Key and Value fields.
- To add additional key and value information, click Add Another.
- When done, click Save.
Body
To set the Body information:
- On the Create Account panel, select Body.
- Select Raw.
- Complete the Body information by entering the text as written below.
{ "active": $plan.active$, "email": "$plan.email$", "firstname": "$plan.firstname$", "lastname": "$plan.lastname$", "password": "$plan.password$", "passwordConfirm": "$plan.password$", "username": "$plan.username$" }
Response Information
To set the Response Information:
- On the Create Account panel, select Response Information.
- Set the Root Path and Success Codes.
- Click Save.
Response Mapping
To set the Response Mapping information:
- On the Create Account panel, select Response Mapping.
- Set a Schema Attribute and the Attribute Path.
- To add additional values, click Add Another.
- When done, click Save.
Add Role to User and Remove Role from User
General Information
To set the Add Role to User information:
- On the Add Role to User panel, ensure that General Information is selected.
- Enter a unique Operation Name, such as Add Role to User.
- Ensure the Operation Type is set to Add Entitlement.
- Enter the Context URL.
- Ensure the HTTP Method is set to PUT.
- Click Save.
To set the Remove Role from User information:
- On the Remove Role from User panel, ensure that General Information is selected.
- Enter a unique Operation Name, such as Remove Role from User.
- Ensure the Operation Type is set to Remove Entitlement.
- Enter the Context URL.
- Ensure the HTTP Method is set to DELETE.
- Click Save.
Headers
To set the Headers information:
- On the Add Role to User (or Remove Role from User) panel, select Headers.
- Complete the Key and Value fields.
- To add additional key and value information, click Add Another.
- When done, click Save.
Response Information
To set the Response Information:
- On the Add Role to User (or Remove Role from User) panel, select Response Information.
- Set the Root Path and Success Codes.
- Click Save.
Response Mapping
To set the Response Mapping information:
- On the Add Role to User (or Remove Role from User) panel, select Response Mapping.
- Set a Schema Attribute and the Attribute Path.
- To add additional values, click Add Another.
- When done, click Save.
Disable Account and Enable Account
Both HTTP Operations are accomplished in two steps, and only differ in the General Information and Body page for step 2 (Disable Account – 2 and Enable Account – 2).
Disable Account -1 and Enable Account -1
General Information
To set the Disable Account-1 information:
- On the Disable Account -1 panel, ensure that General Information is selected.
- Enter a unique Operation Name, such as Disable Account-1.
- Ensure the Operation Type is set to Disable Account.
- Enter the Context URL.
- Ensure the HTTP Method is set to GET.
- Click Save.
To set the Enable Account-1 information:
- On the Enable Account -1 panel, ensure that General Information is selected.
- Enter a unique Operation Name, such as Enable Account-1.
- Ensure the Operation Type is set to Enable Account.
- Enter the Context URL.
- Ensure the HTTP Method is set to GET.
- Click Save.
Headers
To set the Headers information:
- On the Disable Account-1 (or Enable Account-1) panel, select Headers.
- Complete the Key and Value fields.
- To add additional key and value information, click Add Another.
- When done, click Save.
Response Information
To set the Response Information:
- On the Disable Account-1 (or Enable Account-1) panel, select Response Information.
- Set the Root Path and Success Codes.
Response Mapping
To set the Response Mapping information:
- On the Disable Account-1 (or Enable Account-1) panel, select Response Mapping.
- Set a Schema Attribute and the Attribute Path.
- To add additional values, click Add Another.
- When done, click Save.
Disable Account-2 and Enable Account-2
General Information
To set the Disable Account-2 information:
- On the Disable Account -2 panel, ensure that General Information is selected.
- Enter a unique Operation Name, such as Disable Account-2.
- Ensure the Operation Type is set to Disable Account.
- Enter the Context URL.
- Ensure the HTTP Method is set to PUT.
- Click Save.
To set the Enable Account-2 information:
- On the Enable Account -2 panel, ensure that General Information is selected.
- Enter a unique Operation Name, such as Enable Account-2.
- Ensure the Operation Type is set to Enable Account.
- Enter the Context URL.
- Ensure the HTTP Method is set to PUT.
- Click Save.
Headers (Disable Account-2 only)
To set the Headers information:
- On the Disable Account-2 panel, select Headers.
- Complete the Key and Value fields.
- To add additional key and value information, click Add Another.
- When done, click Save.
Body (Disable Account-2 and Enable Account-2)
To set the Body information for Disable Account-2:
- On the Disable Account-2 panel, select Body.
- Select Raw.
- Complete the Body information by entering the text as written below.
{ "username": "$response.username$", "email": "$response.email$", "firstname": "$response.firstname$", "lastname": "$response.lastname$", "active": false }
- When done, click Save.
To set the Body information for Enable Account-2:
- On the Enable Account-2 panel, select Body.
- Select Raw.
- Complete the Body information by entering the text as written below.
{ "username": "$response.username$", "email": "$response.email$", "firstname": "$response.firstname$", "lastname": "$response.lastname$", "active": true }
- When done, click Save.
Response Information (Disable Account-2 only)
To set the Response Information:
- On the Disable Account-2 panel, select Response Information.
- Set the Root Path and Success Codes.
- Click Save.
Response Mapping (Disable Account-2 only)
To set the Response Mapping information:
- On the Disable Account-2 panel, select Response Mapping.
- Set a Schema Attribute and the Attribute Path.
- To add additional values, click Add Another.
- When done, click Save.
Update Password
General Information
To set the Update Password information:
- On the Update Password panel, ensure that General Information is selected.
- Enter a unique Operation Name.
- Ensure the Operation Type is set to Change Password.
- Enter the Context URL.
- Ensure the HTTP Method is set to PUT.
- Click Save.
Headers
To set the Headers information:
- On the Update Password panel, select Headers.
- Complete the Key and Value fields.
- To add additional key and value information, click Add Another.
- When done, click Save.
Body
To set the Body information:
- On the Update Password panel, select Body.
- Select Raw.
- Complete the Body information by entering the text as written below.
{"new_password":"$plan.password$"}
Response Information
To set the Response Information:
- On the Update Password panel, select Response Information.
- Set the Root Path and Success Codes.
- Click Save.
Response Mapping
To set the Response Mapping information:
- On the Update Password panel, select Response Mapping.
- Set a Schema Attribute and the Attribute Path.
- To add additional values, click Add Another.
- When done, click Save.
Unlock Account
General Information
To set the Unlock Account information:
- On the Unlock Account panel, ensure that General Information is selected.
- Enter a unique Operation Name.
- Ensure the Operation Type is set to Unlock Account.
- Enter the Context URL.
- Ensure the HTTP Method is set to DELETE.
- Click Save.
Headers
To set the Headers information:
- On the Unlock Account panel, select Headers.
- Complete the Key and Value fields.
- To add additional key and value information, click Add Another.
- When done, click Save.
Response Information
To set the Response Information:
- On the Unlock Account panel, select Response Information.
- Set the Root Path and Success Codes.
- Click Save.
Response Mapping
To set the Response Mapping information:
- On the Unlock Account panel, select Response Mapping.
- Set a Schema Attribute and the Attribute Path.
- To add additional values, click Add Another.
- When done, click Save.
Delete Account
General Information
To set the Delete Account information:
- On the Delete Account panel, ensure that General Information is selected.
- Enter a unique Operation Name.
- Ensure the Operation Type is set to Delete Account.
- Enter the Context URL.
- Ensure the HTTP Method is set to DELETE.
- Click Save.
Headers
To set the Headers information:
- On the Delete Account panel, select Headers.
- Complete the Key and Value fields.
- To add additional key and value information, click Add Another.
- When done, click Save.
Response Information
To set the Response Information:
- On the Delete Account panel, select Response Information.
- Set the Root Path and Success Codes.
- Click Save.
This completes the list of HTTP Operations.
Now that we have HTTP Operations defined, we can test the connection.