Extended customization of the Loginapp REST UI for OAuth, OIDC, and SAML

TENANT_ID is an attribute in the REST API that is only available in setups using OAuth, OIDC, or SAML. TENANT_ID contains an identifier of the client (OAuth, OIDC) or the entityID (SAML) that is interacting with IAM.

The purpose of the TENANT_ID is to provide styling and customization depending on the ID of the client.

Configuration of tenant ID

To use TENANT_ID requires no configuration. The attribute is automatically provided in all use case scenarios where an authenticated client or a SAML entityId is involved.

For customization in the SDK, the attribute is named TENANT_ID. For customization in Javascript, the attribute is named uiTenantId.

Using the tenant ID with the SDK

To use the SDK with different tenant IDs, add the following entry in custom.sdk.config.js:

config.uiTenantId = 'myTenant'

Use case

  • A typical use case scenario for OAuth is:
  • Several tenants use the same authorization server.
  • Each tenant provides its users with a mobile app or a web application.
  • Mobile apps and web applications are all registered as clients in the IAM authorization server with their own client IDs.
  • During the authorization code flow, IAM identifies the clients with their client ID and supplies this information as TENANT_ID to the REST UI.
  • The Loginapp REST UI applies styling and customization depending on the TENANT_ID, FLOW_ID, and STEP_ID.