Skip to main content

Workflow Realm Settings Endpoint

Introduction

Use the /workflow PATCH endpoint to dictate the end-user login process, configure Device Recognition, enable redirects, customize token settings.

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. Integrate a membership and profile directory(s) with SecureAuth IdP (Data Realm Settings Endpoint)

/workflow Endpoint

Note

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

Workflow Settings /workflow PATCH Endpoint

Notice

Use this endpoint to configure the realm's workflow settings, including client-side login process, device recognition, token preferences, and user redirects.

HTTP Method

Endpoint

Example

SecureAuth IdP version

PATCH

/workflow
https://secureauth.company.com/api/v1/realms/26/workflow

v9.1

PATCH

/workflow
https://secureauth.company.com/api/v2/realms/26/workflow

v9.2 or later