Skip to main content

Data Realm Settings Endpoints

Introduction

Use the /data PATCH endpoints to integrate membership and profile directories, map profile properties to directory attributes, and customize global auxiliary fields.

Prerequisites

1. Complete the Enablement and Header Steps in the Admin API Guide

2. Have access to the application code that calls to the API endpoint(s)

3. Have a corporate directory with which to integrate for end-user membership (login) credentials

4. Have a corporate directory(s) with which to integrate for end-user profile information

5. Designate or create a SecureAuth service account in the directory with read and (optional) write access to membership and profile information

/data Endpoints

Note

The following endpoints are prepended with the URL, https://<SecureAuth IdP Domain>/api/v2/realms/<realm ID>

Membership Directory Integration /data/membership PATCH Endpoint

Notice

Use this endpoint to configure the realm's Membership Directory integration. This is the information with which the end-user logs into the realm, but may not contain profile information required for authentication or assertion.

NOTE: The supported directory types are LDAP (AD and others), SQL Server, Oracle Database, Microsoft Azure AD, and Web Service (Multi-Data Store) (pulls Membership information from other SecureAuth IdP realms' Membership directory integrations).

HTTP Method

Endpoint

Example

SecureAuth IdP version

PATCH

/data/membership 
https://secureauth.company.com/api/v2/realms/26/data/membership 

v9.2 or later

Profile Provider Directory Integration(s) /data/profile PATCH Endpoint

Notice

Use this endpoint to configure the realm's Profile Provider Directory integration(s). This integration(s) includes end-user profile data, which is utilized for authentication and assertion purposes.

Multiple data stores can be configured, enabling SecureAuth IdP to pull profile information from various sources; and the same directory integration used for the Membership integration can be repeated at this endpoint.

HTTP Method

Endpoint

Example

SecureAuth IdP version

PATCH

/data/profile
https://secureauth.company.com/api/v2/realms/26/data/profile

v9.2 or later

Global Auxiliary Fields /data/globalaux PATCH Endpoint

Notice

Use this endpoint to configure the realm's Global Auxiliary values, which are standard values that are asserted from SecureAuth IdP to the SP for each end-user without requiring directory storage.

HTTP Method

Endpoint

Example

SecureAuth IdP version

PATCH

/data/globalaux
https://secureauth.company.com/api/v2/realms/26/data/globalaux

v9.2 or later