Configure Single Sign-On (SSO)

Overview

You can configure a single or multiple methods of SSO to log in to IPLM Web using the IPLM public API.

The former method using SSO_URL in piweb.conf is not supported in IPLM Web 2026.1 and beyond.

Create a new configuration

Minimum body to create a new configuration

POST http://{{HOSTNAME}}:{{PORT}}/admin/{{VERSION}}/external-auth-config

Copy 
{
    name: "auth1",
    description: "auth1",
    base_url: "https://auth1",
    user_identifier: "nameID",
    execution_timeout: "30 seconds"    
}

 

Update an existing configuration

Minimum body to update an existing configuration

PUT http://{{HOSTNAME}}:{{PORT}}/admin/{{VERSION}}/external-auth-config/{{EXTERNAL_AUTH_ID}}

Copy 
{
    name: "auth1",
    description: "auth1",
    base_url: "https://auth1",
    user_identifier: "nameID",
    execution_timeout: "30 seconds"
    uc: 1    
}

Delete a configuration

Minimum body to delete an existing configuration

DELETE http://{{HOSTNAME}}:{{PORT}}/admin/{{VERSION}}/external-auth-config/{{EXTERNAL_AUTH_ID}}

Copy 
{
    name: "auth1",
    description: "auth1",
    base_url: "https://auth1",
    user_identifier: "nameID",
    execution_timeout: "30 seconds"
    uc: 1    
}

Get a list of current configuration

http://{{HOSTNAME}}:{{PORT}}/admin/{{VERSION}}/external-auth-config

Example output:

Copy 
{
    "data": [
        {
            "name": "auth1",
            "description": "auth1 configuration",
            "base_url": "https://auth1",
            "user_identifier": "nameID",
            "execution_timeout": "30 seconds"
        },
        {
           ...
           ...
        }
    ]
}

Configuration settings

The following outlines the settings for the configuration.

Setting Description
name

Enter a name for the SSO setting.

  • Required string value

  • Must be unique.
description

Enter a description for the SSO setting.

  • Optional string value
baseUrl

Enter the base URL for the SSO setting.

  • Required string value
userIdentifier

  • Optional string value

  • Default is 'nameID'
executionTimeout

  • Optional duration

  • Default is 30 seconds