IBM Support

How to reset Butler IdP configuration

How To


Summary

An article to assist with the reset of the IdP configuration which will restore access with default credentials in the case that mismatching IdP configuration makes access to the TU impossible.

Objective

This will restore access in the following circumstances:
  • When the baseDomain of a self-hosted backend changed without prior reconfiguration of the IdP settings.
  • When IdP is not accessible anymore due to any circumstance.
  • When PostgreSQL was restored with a differing configuration.

Environment

Prerequesites:
  • Access to PostgreSQL instance where butlerdb database is hosted.
  • PostgreSQL client or some cloud providers SQL tool.
  • Access to the host or pod where the butler process is running.

Steps

Removing specific IdP configuration in PostgreSQL
  • Connect to PostgreSQL database with psql client or similar, using the same credentials in Instana and pick butlerdb database.
  • Find tenantId(s) in the following way:​​​​​​
SELECT * FROM identity_provider WHERE tenant_id = '<tenantId>';
Take note of the tenantId(s) that are causing issues and if needed, write down the content of the table. Can be helpful in reconfiguring IdP afterwards.
  • Then run following statement in database for each problematic tenantId:
DELETE FROM identity_provider WHERE tenant_id = '<tenantId>';
Update Butler state via API
To also tell butler to drop the IdP configuration, there are two equivalent options.
Connect to the pod/container/host where the Butler process is located and run either:
curl --request DELETE --url http://localhost:8600/identityProviders/saml/<tenantName>
or
curl --request PUT --url http://localhost:8600/admin/authentication/<tenantName>/idp
  • Restart the Butler service and access without IdP should be possible now.

Additional Information

​​

Document Location

Worldwide

[{"Type":"MASTER","Line of Business":{"code":"LOB45","label":"Automation"},"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Product":{"code":"SSE1JP5","label":"IBM Instana Observability"},"ARM Category":[{"code":"a8m3p000000UoURAA0","label":"User Management \u0026 Authorization"}],"ARM Case Number":"","Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"All Versions"}]

Document Information

Modified date:
08 August 2023

UID

ibm17010919