Skip to content

Integrating SailPoint with Web Services

This connector allows you to configure any web service supported managed system which can read and write on the managed system using the respective managed system Web Services.

Web Services supports JSON and XML for read and write.

Warning

When configuring the source, do not hard code sensitive data. If sensitive data is hard coded, it can lead to that data being exposed when moving to a production environment. SailPoint recommends putting sensitive information in the encrypted attribute value list in the application XML and then using the encrypted variable name when configuring the source. For example, if you want to add the custom variable Custom_Variable in the encrypted list, append the variable name in the following list: <entry key="encrypted" value="accesstoken, refresh_token, Custom_Variable"/>

Note

To view the latest features, enhancements, and fixes for all SaaS connectors, refer to the SaaS Release Notes page.

Supported Managed Systems

The SailPoint Web Services connector supports SOAP and REST web services with XML and JSON response format.

Prerequisites

  • Configure at least one virtual appliance cluster and successfully test the connection. Refer to the Virtual Appliance Reference Guide for more information.
  • Web Services must be accessible.

Required Permissions

The user/administrator must have the required permissions to call the Web Services API of the managed system.

Supported Features

The Web Services source supports the features listed below.

  • Test Connection
  • Account Aggregation
  • Account Delta Aggregation

  • Create, Update, Delete Accounts

    Note

    Delete Account is possible using a Before Operation rule. For example, you can change the provisioning plan's account operation from disable to delete. Refer to Web Services Before Operation Rule for more information.

  • Enable, Disable Accounts

  • Get Object
  • Entitlement Aggregation
  • Add/Remove Entitlement
  • Add entitlements when enabling accounts
  • Remove entitlements when disabling accounts
  • Change Password
  • Passthrough Authentication
  • Unlock Account: The schema attribute is Account Lock Status.

  • Authentication

    Additional credentials are required to connect the Web Service source to the managed system. The following are the supported authentication methods:

    • Basic Authentication
    • OAuth2 Authentication
    • API Token (This source does not generate OAuth tokens based on a client ID and client secret key. You need to provide an access token - API token).
    • No/Custom Authentication

    The Web Services source supports XML format for the Basic Authentication using username and password.

    Note

    For the API endpoints with SSL, provide the client certificate details, refer to Common Configuration.

  • Expression language use in URLs, Header values, and Body

    Note

    The connector supports expression language with string and primitive data types such as Boolean and numbers. It does not support Collection(s) and Array(s).

    Refer to Using Expression Language for more information.

  • Supports a rate limit mechanism which handles as prescribed by the IETF implementation. Refer to RateLimit Header Fields for HTTP for more information.

    The rate limiting mechanism is engaged after receiving the 429 status code in the response. An exponential back-off depending upon the Retry-After response header occurs before attempting the re-trigger of the request. At maximum, the API request re-trigger is attempted at, twice, after receiving the first 429 response. The URL is encoded regardless of the throttleEnabled flag value.

  • Multiple Group Objects

    The Web Services source supports the multiple group objects. Refer to Multiple Group Objects for more information.

  • Application layer proxy

Important

The Web Services Source manages the request for multiple operations performed sequentially. Refer to SailPoint Source Features for more information on features.

Documentation Feedback

Feedback is provided as an informational resource only and does not form part of SailPoint’s official product documentation. SailPoint does not warrant or make any guarantees about the feedback (including without limitation as to its accuracy, relevance, or reliability). All feedback is subject to the terms set forth at https://developer.sailpoint.com/discuss/tos.