HTTP Operations

Image of the IdentityNow HTTP Operations panel

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

Image of the IdentityNow Authenticate General Information panel

To set the Authenticate information:

  1. On the Authenticate panel, ensure that General Information is selected.
  2. Enter a unique Operation Name.
  3. Ensure the Operation Type is set to Custom Authentication.
  4. Enter the Context URL.
  5. Replace the BIUL instance https://ubuntu-elk:58082 with the actual BIUL server URL you want to configure the connector for.
  6. Ensure the HTTP Method is set to POST.
  7. Click Save.

Headers

Image of the IdentityNow Authenticate Headers panel

To set the Headers information:

  1. On the Authenticate panel, select Headers.
  2. Complete the Key and Value fields.
  3. To add additional key and value information, click Add Another.
  4. When done, click Save.

 

Body

Image of the IdentityNow Authenticate Body panel

To set the Body information:

  1. On the Authenticate panel, select Body.
  2. Select Raw.
  3. Complete the Body information by entering the text as written below.

 

{"domain":"","dsDomain":"","dsID":0,"password":"$application.password$","username":"$application.username$"}
  1. Click Save.

Response Information

Image of the IdentityNow Authenticate Response Information panel

To set the Response Information:

  1. On the Authenticate panel, select Response Information.
  2. Set the Root Path and Success Codes.
  3. Click Save.

 

 

Response Mapping

Image of the IdentityNow Authenticate Response Mapping panel

To set the Response Mapping information:

  1. On the Authenticate panel, select Response Mapping.
  2. Save the token included in the response into a _CA variable for encrypted values.
  3. 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

Image of the IdentityNow Test Connection General Information panel

To set the Test Connection information:

  1. On the Test Connection panel, ensure that General Information is selected.
  2. Enter a unique Operation Name.
  3. Ensure the Operation Type is set to Test Connection.
  4. Enter the Context URL.
  5. Ensure the HTTP Method is set to GET.
  6. Click Save.

 

Headers

Image of the IdentityNow Test Connection Headers panel

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:

  1. On the Test Connection panel, select Headers.
  2. Complete the Key and Value fields.
  3. To add additional key and value information, click Add Another.
  4. When done, click Save.

 

Response Information

Image of the IdentityNow Test Connection Response Information panel

To set the Response Information:

  1. On the Test Connection panel, select Response Information.
  2. Set the Root Path and Success Codes.
  3. Click Save.

 

Account Aggregation

General information

Image of the IdentityNow Account Aggregation General Information panel

To set the Account Aggregation information:

  1. On the Account Aggregation panel, ensure that General Information is selected.
  2. Enter a unique Operation Name.
  3. Ensure the Operation Type is set to Account Aggregation.
  4. Enter the Context URL.
  5. Ensure the HTTP Method is set to GET.
  6. Click Save.

 

Headers

Image of the IdentityNow Account Aggregation Headers panel

To set the Headers information:

  1. On the Account Aggregation panel, select Headers.
  2. Complete the Key and Value fields.
  3. To add additional key and value information, click Add Another.
  4. When done, click Save.

 

Response Information

Image of the IdentityNow Account Aggregation Response Information panel

To set the Response Information:

  1. On the Account Aggregation panel, select Response Information.
  2. Set the Root Path and Success Codes.
  3. Click Save.

 

Response Mapping

Image of the IdentityNow Account Aggregation Response Mapping panel

To set the Response Mapping information:

  1. On the Account Aggregation panel, select Response Mapping.
  2. Set a Schema Attribute and the Attribute Path.
  3. To add additional values, click Add Another.
  4. When done, click Save.

 

Role Aggregation

General information

Image of the IdentityNow Role Aggregation General Information panel

To set the Role Aggregation information:

  1. On the Role Aggregation panel, ensure that General Information is selected.
  2. Enter a unique Operation Name.
  3. Ensure the Operation Type is set to Group Aggregation.
  4. Enter the Context URL.
  5. Ensure the HTTP Method is set to GET.
  6. Click Save.

 

Headers

Image of the IdentityNow Role Aggregation Headers panel

To set the Headers information:

  1. On the Role Aggregation panel, select Headers.
  2. Complete the Key and Value fields.
  3. To add additional key and value information, click Add Another.
  4. When done, click Save.

 

Response Information

Image of the IdentityNow Role Aggregation Response Information panel

To set the Response Information:

  1. On the Role Aggregation panel, select Response Information.
  2. Set the Root Path and Success Codes.
  3. Click Save.

 

Response Mapping

Image of the IdentityNow Role Aggregation Response Mapping panel

To set the Response Mapping information:

  1. On the Role Aggregation panel, select Response Mapping.
  2. Set a Schema Attribute and the Attribute Path.
  3. To add additional values, click Add Another.
  4. When done, click Save.

 

Create Account

General information

Image of the IdentityNow Create Account General Information panel

To set the Create Account information:

  1. On the Create Account panel, ensure that General Information is selected.
  2. Enter a unique Operation Name.
  3. Ensure the Operation Type is set to Create Account.
  4. Enter the Context URL.
  5. Ensure the HTTP Method is set to POST.
  6. Click Save.

 

Headers

Image of the IdentityNow Create Account Headers panel

To set the Headers information:

  1. On the Create Account panel, select Headers.
  2. Complete the Key and Value fields.
  3. To add additional key and value information, click Add Another.
  4. When done, click Save.

 

Body

Image of the IdentityNow Create Account Body panel

To set the Body information:

  1. On the Create Account panel, select Body.
  2. Select Raw.
  3. 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

Image of the IdentityNow Create Account Response Information panel

To set the Response Information:

  1. On the Create Account panel, select Response Information.
  2. Set the Root Path and Success Codes.
  3. Click Save.

 

Response Mapping

Image of the IdentityNow Create Accountg Response Mapping panel

To set the Response Mapping information:

  1. On the Create Account panel, select Response Mapping.
  2. Set a Schema Attribute and the Attribute Path.
  3. To add additional values, click Add Another.
  4. When done, click Save.

 

Add Role to User and Remove Role from User

General Information

Image of the IdentityNow Add Role to User General Information panel

To set the Add Role to User information:

  1. On the Add Role to User panel, ensure that General Information is selected.
  2. Enter a unique Operation Name, such as Add Role to User.
  3. Ensure the Operation Type is set to Add Entitlement.
  4. Enter the Context URL.
  5. Ensure the HTTP Method is set to PUT.
  6. Click Save.

 

Image of the IdentityNow Remove Role from User General Information panel

To set the Remove Role from User information:

  1. On the Remove Role from User panel, ensure that General Information is selected.
  2. Enter a unique Operation Name, such as Remove Role from User.
  3. Ensure the Operation Type is set to Remove Entitlement.
  4. Enter the Context URL.
  5. Ensure the HTTP Method is set to DELETE.
  6. Click Save.

 

Headers

Image of the IdentityNow Add Role to User Headers panel

To set the Headers information:

  1. On the Add Role to User (or Remove Role from User) panel, select Headers.
  2. Complete the Key and Value fields.
  3. To add additional key and value information, click Add Another.
  4. When done, click Save.

 

Response Information

Image of the IdentityNow Add Role to User Response Information panel

To set the Response Information:

  1. On the Add Role to User (or Remove Role from User) panel, select Response Information.
  2. Set the Root Path and Success Codes.
  3. Click Save.

 

Response Mapping

Image of the IdentityNow Add Role to User Response Mapping panel

To set the Response Mapping information:

  1. On the Add Role to User (or Remove Role from User) panel, select Response Mapping.
  2. Set a Schema Attribute and the Attribute Path.
  3. To add additional values, click Add Another.
  4. 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

Image of the IdentityNow Disable Account-1 General Information panel

To set the Disable Account-1 information:

  1. On the Disable Account -1 panel, ensure that General Information is selected.
  2. Enter a unique Operation Name, such as Disable Account-1.
  3. Ensure the Operation Type is set to Disable Account.
  4. Enter the Context URL.
  5. Ensure the HTTP Method is set to GET.
  6. Click Save.

 

Image of the IdentityNow Enable Account-1 General Information panel

To set the Enable Account-1 information:

  1. On the Enable Account -1 panel, ensure that General Information is selected.
  2. Enter a unique Operation Name, such as Enable Account-1.
  3. Ensure the Operation Type is set to Enable Account.
  4. Enter the Context URL.
  5. Ensure the HTTP Method is set to GET.
  6. Click Save.

 

Headers

Image of the IdentityNow Disable Account-1 Headers panel

To set the Headers information:

  1. On the Disable Account-1 (or Enable Account-1) panel, select Headers.
  2. Complete the Key and Value fields.
  3. To add additional key and value information, click Add Another.
  4. When done, click Save.

 

Response Information

Image of the IdentityNow Disable Account-1 Response Information panel

To set the Response Information:

  1. On the Disable Account-1 (or Enable Account-1) panel, select Response Information.
  2. Set the Root Path and Success Codes.

 

Response Mapping

Image of the IdentityNow Disable Account-1 Response Mapping panel

To set the Response Mapping information:

  1. On the Disable Account-1 (or Enable Account-1) panel, select Response Mapping.
  2. Set a Schema Attribute and the Attribute Path.
  3. To add additional values, click Add Another.
  4. When done, click Save.

 

Disable Account-2 and Enable Account-2

General Information

Image of the IdentityNow Disable Account-2 General Information panel

To set the Disable Account-2 information:

  1. On the Disable Account -2 panel, ensure that General Information is selected.
  2. Enter a unique Operation Name, such as Disable Account-2.
  3. Ensure the Operation Type is set to Disable Account.
  4. Enter the Context URL.
  5. Ensure the HTTP Method is set to PUT.
  6. Click Save.

 

Image of the IdentityNow Enable Account-2 General Information panel

To set the Enable Account-2 information:

  1. On the Enable Account -2 panel, ensure that General Information is selected.
  2. Enter a unique Operation Name, such as Enable Account-2.
  3. Ensure the Operation Type is set to Enable Account.
  4. Enter the Context URL.
  5. Ensure the HTTP Method is set to PUT.
  6. Click Save.

 

Headers (Disable Account-2 only)

Image of ther IdentityNow Disable Account-2 Headers panel

To set the Headers information:

  1. On the Disable Account-2 panel, select Headers.
  2. Complete the Key and Value fields.
  3. To add additional key and value information, click Add Another.
  4. When done, click Save.

 

Body (Disable Account-2 and Enable Account-2)

Image of the IdentityNow Disable Account-2 Body panel

To set the Body information for Disable Account-2:

  1. On the Disable Account-2 panel, select Body.
  2. Select Raw.
  3. 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
}
  1. When done, click Save.

Image of the IdentityNow Enable Account-2 Body panel.

To set the Body information for Enable Account-2:

  1. On the Enable Account-2 panel, select Body.
  2. Select Raw.
  3. 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
}
  1. When done, click Save.

Response Information (Disable Account-2 only)

Image of the IdentityNow Disable Account-2 Response Information panel

To set the Response Information:

  1. On the Disable Account-2 panel, select Response Information.
  2. Set the Root Path and Success Codes.
  3. Click Save.

 

Response Mapping (Disable Account-2 only)

Image of the IdentityNow Disable Account-2 Response Mapping panel

To set the Response Mapping information:

  1. On the Disable Account-2 panel, select Response Mapping.
  2. Set a Schema Attribute and the Attribute Path.
  3. To add additional values, click Add Another.
  4. When done, click Save.

 

Update Password

General Information

Image of the IdentityNow Update Password General Information panel

To set the Update Password information:

  1. On the Update Password panel, ensure that General Information is selected.
  2. Enter a unique Operation Name.
  3. Ensure the Operation Type is set to Change Password.
  4. Enter the Context URL.
  5. Ensure the HTTP Method is set to PUT.
  6. Click Save.

 

Headers

Image of the IdentityNow Update Password Headers panel

To set the Headers information:

  1. On the Update Password panel, select Headers.
  2. Complete the Key and Value fields.
  3. To add additional key and value information, click Add Another.
  4. When done, click Save.

 

Body

Image of the IdentityNow Update Password Body panel

To set the Body information:

  1. On the Update Password panel, select Body.
  2. Select Raw.
  3. Complete the Body information by entering the text as written below.

 

{"new_password":"$plan.password$"}

Response Information

Image of the IdentityNow Update Password Response Information panel

To set the Response Information:

  1. On the Update Password panel, select Response Information.
  2. Set the Root Path and Success Codes.
  3. Click Save.

 

Response Mapping

Image of the IdentityNow Update Password Response Mapping panel

To set the Response Mapping information:

  1. On the Update Password panel, select Response Mapping.
  2. Set a Schema Attribute and the Attribute Path.
  3. To add additional values, click Add Another.
  4. When done, click Save.

 

Unlock Account

General Information

Image of the IdentityNow Unlock Account General Information panel

To set the Unlock Account information:

  1. On the Unlock Account panel, ensure that General Information is selected.
  2. Enter a unique Operation Name.
  3. Ensure the Operation Type is set to Unlock Account.
  4. Enter the Context URL.
  5. Ensure the HTTP Method is set to DELETE.
  6. Click Save.

 

Headers

Image of the IdentityNow Unlock Account Headers panel

To set the Headers information:

  1. On the Unlock Account panel, select Headers.
  2. Complete the Key and Value fields.
  3. To add additional key and value information, click Add Another.
  4. When done, click Save.

 

Response Information

Image of the IdentityNow Unlock Account Response Information panel

To set the Response Information:

  1. On the Unlock Account panel, select Response Information.
  2. Set the Root Path and Success Codes.
  3. Click Save.

 

Response Mapping

Image of the IdentityNow Unlock Account Response Mapping panel

To set the Response Mapping information:

  1. On the Unlock Account panel, select Response Mapping.
  2. Set a Schema Attribute and the Attribute Path.
  3. To add additional values, click Add Another.
  4. When done, click Save.

 

Delete Account

General Information

Image of the IdentityNow Delete Account General Information panel

To set the Delete Account information:

  1. On the Delete Account panel, ensure that General Information is selected.
  2. Enter a unique Operation Name.
  3. Ensure the Operation Type is set to Delete Account.
  4. Enter the Context URL.
  5. Ensure the HTTP Method is set to DELETE.
  6. Click Save.

 

Headers

Image of the IdentityNow Delete Account Headers panel

To set the Headers information:

  1. On the Delete Account panel, select Headers.
  2. Complete the Key and Value fields.
  3. To add additional key and value information, click Add Another.
  4. When done, click Save.

 

Response Information

Image of the IdentityNow Delete Account Response Information panel

To set the Response Information:

  1. On the Delete Account panel, select Response Information.
  2. Set the Root Path and Success Codes.
  3. Click Save.

This completes the list of HTTP Operations.

 

Now that we have HTTP Operations defined, we can test the connection.