Configuration Guide
Configuration Guide
Breadcrumbs

Federation Widget

Definition

Two widgets are available to edit and display the Federation bound to a Resource :

  • The Federation Edit Widget is used to configure/manage the Federation corresponding to an application Resource

  • The Federation Display Widget is used to display the Federation configuration

Federation Edit Widget

Federation Display Widget
image-20260716-132707.png
No federation currently configured


image-20230504-150521.png
No federation currently configured
image-20250217-222937.png


image-20250217-222844.png

Configuration

These widgets are standalone widgets designed to be used in a UI_FOR_OBJECT Feature with the RESOURCE Object kind.

Widget

Properties

The widget has no specific properties.

To enable the copy of an existing federation, set the duplicationEnabled attribute to true. We also recommend adding the applicationsOptions attribute to the Federation Edit Widget's config attribute. This isn't mandatory, but it's recommended.

Example

Federation Edit Widget

Federation Display Widget
XML
<widget id="federation-edit" xsi:type="ctdbum:FederationEditWidgetType">
    <hidden>false</hidden>
    <displayOptions>
      <modalSize>LG</modalSize>
    </displayOptions>
    <config>
      <bordered>false</bordered>
      <title>false</title>
      <applicationOptions>
         <scope type="EXPRESSION" objectKind="RESOURCE">
            <searchExpression>
               <search:And>
                  <search:Prop op="EQUALS" name="category">
                     <value script="false">APPLICATION</value>
                  </search:Prop>
                  <search:Prop op="IS_NOT_NULL" name="federationType" />
               </search:And>
            </searchExpression>
            <objectTypes />
         </scope>
         <search>
            <actions />
            <allowExport>false</allowExport>
            <columns>
               <column>
                  <attribute>true</attribute>
                  <dataKey>id</dataKey>
                  <dataType>string</dataType>
                  <dateFormat>DAY_MONTH_YEAR_LONG</dateFormat>
                  <ellipsis>false</ellipsis>
                  <hidden>true</hidden>
                  <sortAs>ALPHA</sortAs>
                  <sortDirection>ASC</sortDirection>
                  <sortable>true</sortable>
                  <sorted>false</sorted>
                  <timeZoneStrategy>BROWSER</timeZoneStrategy>
                  <type>general</type>
               </column>
               <column>
                  <attribute>true</attribute>
                  <dataKey>rsrcName</dataKey>
                  <dataType>string</dataType>
                  <dateFormat>DAY_MONTH_YEAR_LONG</dateFormat>
                  <ellipsis>false</ellipsis>
                  <hidden>false</hidden>
                  <sortAs>ALPHA</sortAs>
                  <sortDirection>ASC</sortDirection>
                  <sortable>true</sortable>
                  <sorted>true</sorted>
                  <timeZoneStrategy>BROWSER</timeZoneStrategy>
                  <type>general</type>
               </column>
               <column>
                  <attribute>true</attribute>
                  <dataKey>federationType</dataKey>
                  <dataType>string</dataType>
                  <dateFormat>DAY_MONTH_YEAR_LONG</dateFormat>
                  <ellipsis>false</ellipsis>
                  <hidden>false</hidden>
                  <sortAs>ALPHA</sortAs>
                  <sortDirection>ASC</sortDirection>
                  <sortable>false</sortable>
                  <sorted>false</sorted>
                  <timeZoneStrategy>BROWSER</timeZoneStrategy>
                  <type>general</type>
               </column>
               <column>
                  <attribute>true</attribute>
                  <dataKey>federationStatus</dataKey>
                  <dataType>string</dataType>
                  <dateFormat>DAY_MONTH_YEAR_LONG</dateFormat>
                  <ellipsis>false</ellipsis>
                  <hidden>false</hidden>
                  <sortAs>ALPHA</sortAs>
                  <sortDirection>ASC</sortDirection>
                  <sortable>false</sortable>
                  <sorted>false</sorted>
                  <timeZoneStrategy>BROWSER</timeZoneStrategy>
                  <type>general</type>
              </column>
              </columns>
              <rowClickActions />
              <additionalSearchAttributes />
              <displayFrozenOperators>true</displayFrozenOperators>
              <frozen>NO</frozen>
              <modes>
                 <mode>SIMPLE</mode>
                 <mode>MULTICRITERIA</mode>
              </modes>
              <objectReferences />
           </search>
        </applicationOptions>
        <duplicationEnabled>true</duplicationEnabled>
    </config>
</widget>
XML
<widget id="federation-display" xsi:type="ctdbum:FederationDisplayWidgetType">
    <hidden>false</hidden>
    <displayOptions>
      <modalSize>LG</modalSize>
    </displayOptions>
    <config>
      <bordered>true</bordered>
      <title>true</title>
    </config>
</widget>

Settings

The widget needs to have the following settings configured in the dataset.

Setting Name

Mandatory

Type

Description

amcp.am.available-authentication-levels

YES

List<Integer>

The authentication levels supported by the tenant.

amcp.am.default-assertion-signature-certificates.saml

NO

String

The default certificate used to sign SAML assertions. Will be pre-selected when creating a SAML Federation.

Must be included in the keys of amcp.am.instances.<instanceName>.configuration.assertion-signature-certificates

amcp.am.default-assertion-signature-certificates.ws-fed

NO

String

The default certificate used to sign WSFED assertions. Will be pre-selected when creating a WSFED Federation.

Must be included in the keys of amcp.am.instances.<instanceName>.configuration.assertion-signature-certificates

amcp.am.federation-reporting-collection

YES

String

Identifier of reporting configuration containing federations.

amcp.am.federation-mapping-reporting-collection

YES

String

Identifier of reporting configuration containing federation mappings.

amcp.am.certificate.expiration.warning-period

YES

String

Period prior to certificate expiration displaying a warning message on the concerned federations.

I18n

Some i18n keys are dependent on the configuration and must be configured manually.