Advanced SaaS user configuration

Depending on the API of the vendor application, you might need to make an additional API call and add additional parameters to retrieve SaaS user information such as the user's role and last activity timestamp.

Before you start

In the Integration Details section, select the Deactivate checkbox. Go to the Advanced SaaS User Software Configuration section and click Edit . 

Format of the additional API request

Web Service URL field

In most cases an additional API call is required either to the activity logs or a separate dedicated endpoint to return role information. 

If an additional API request is required to return software information, review the following information.

Let's say the integration list response is formatted as follows:
 

The Web Service URL that was entered on the Integration details page is https://api.example.com/users_list. You enter https://api.example.com/users_list/external_id={{detail_response.external_id}} as the Web Service URL to retrieve the SaaS user information.

Last Login Key, Deactivate Criteria, Role Field, and Specify Key Role Field

How you reference the fields to extract the SaaS information and deactivate users depends on whether you add an additional API call:

• An additional API call was added.  The format is {{saas_user_response.<field_name>}}.
• An additional API call was not added. The format is {{detail_response.<field_name>}}.

The name of the field is the name of the field in the API response.

Specify Key Role Field

{ "name": "Helen",
"Role" : [ {"name": Admin}, { "name" : Manager} ] }

If the roles are in a list, see example above, you must enter the key to extract the roles. In this example, you enter name  to extract the roles.

Review API responses

To find out the names of the fields in an API response, save your changes. Click Review response and select a response.

Procedure

1. Enable making an additional API call if the SaaS user information is not available in the API response.
2. Enter the Web Service URL.
3. Ensure the method is GET.
4. Optional. Add headers and parameters.
5. In the Result field, enter code to extract the software information from the response. 
   
   If the SaaS user information is nested in a list, enter {{saas_user_response.users[0]}}. In this case, the index is set to [0], because users is the first object in the list.
6. Specify the key to extract the last login timestamp.
7. Enter the deactivate criteria.
8. Specify the path to the role field.
9. Optional. If the roles are contained in a list, you must specify the key to extract the role values.
10. Save your changes.