Specifying a resource path for a REST API datastore - PingFederate - 10.3

PingFederate Server

bundle
pingfederate-103
ft:publication_title
PingFederate Server
Product_Version_ce
PingFederate 10.3
category
Product
pf-103
pingfederate
ContentType_ce

On the Configure Data Source Filters window, you can specify a resource path for a REST API datastore.

On the Configure Data Source Filters window, if the REST API datastore requires a relative path or additional query parameters, or both, to retrieve user records, enter them in the Resource Path field.

Example

You have use cases that can leverage user attributes obtained through REST APIs. The data source returns user records in JSON. It also provides the following paths to access its data based on user populations:

  • https://rest.example.com/development/users
  • https://rest.example.com/staging/users

To retrieve the record of a particular user, the request must include the uid query parameter with the identifier of the user.

Your use cases focus on users under the /staging/users path. Your authentication policy uses the HTML Form Adapter, which captures user identifiers using the username attribute.

To address this sample use case:

  1. Create a REST API datastore with a base URL of https://rest.example.com.
  2. Add the REST API datastore as an attribute source in the applicable use cases, such as a service provider (SP) connection that uses an HTML Form Adapter instance or an OAuth identity provider (IdP) Adapter Mapping configuration that maps from an HTML Form Adapter instance into the persistent grants.
  3. When prompted to configure the filtering option on the Configure Data Source Filters window, enter /staging/users?uid=${username} in the Resource Path field.