Identity Cloud

Configure IDPs, SPs, and CoTs

This section covers configuration tasks to implement SAML v2.0 in Identity Cloud.

During setup, you share metadata for providers that you host with other providers in the circle of trust. You must also configure remote providers, by importing their metadata.

In Identity Cloud, a hosted provider is one served by the current Identity Cloud tenant, and a remote provider is one hosted elsewhere.

Create a circle of trust

A circle of trust groups at least one IDP and at least one SP who agree to share authentication information.

  1. In the AM admin UI go to Realms > Realm Name > Applications > Federation > Circles of Trust, and click Add Circle of Trust.

  2. Provide a name, and click Create.

  3. On the Circle of Trust page, in the Entity Providers property, select at least one IDP and one SP.

    Entity providers can be added at any time. This lets you create IDPs or SPs later on and add them.
  4. Customize any other properties as required, and click Save Changes.

    For information about circle of trust properties, refer to Circle of trust configuration properties.

Create a hosted IDP or SP

A hosted IDP or SP is a provider hosted within Identity Cloud. For example, if Identity Cloud is the authoritative source for users to a downstream application, then you would configure Identity Cloud to be a hosted IDP.

The following procedure provides steps for creating a hosted IDP or SP using the AM admin UI:

  1. In the AM admin UI go to Realms > Realm Name > Dashboard, and then click SAML Applications.

  2. Click Add Entity Provider > Hosted.

  3. Enter an Entity ID, and verify the Entity Provider Base URL value is correct.

    Identity Cloud uses the Entity Provider Base URL value for all SAML v2.0 related endpoints, so ensure other entities in your SAML deployment are able to access the specified URL.

  4. In the Meta Aliases section, provide a URL-friendly value in either the Identity Provider Meta Alias, the Service Provider Meta Alias property, or both.

    Ensure the aliases for providers are unique in a circle of trust, as well as in the realm.

  5. Click Create.

    The AM admin UI only displays the configuration of a single role. To switch between SP and IDP configuration for a given provider, click on the labels to select the role view:

    saml-roles
  6. On the Assertion Processing tab, in the Attribute Mapper section, map SAML attribute names, which are the names in an assertion, to local attribute names.

    In this example, we map the SalesForce IDPEmail SAML attribute to the local mail attribute.
    Figure 1. Mapping SAML Attributes to Local Attributes

    The default mapping implementation has additional features beyond retrieving string attributes from the user profile:

    • Add an attribute that takes a static value by enclosing the profile attribute name in double quotes (").

      For example, you can add a static SAML attribute called partnerID with a value of staticPartnerIDValue by adding partnerID as the SAML Attribute with "staticPartnerIDValue" as the Local Attribute name.

    • Select the binary option when dealing with binary attribute values; for example, values that are Base64 encoded.

    • Use the optional Name Format Uri property as required by the remote provider. For example, you may need to specify urn:oasis:names:tc:SAML:2.0:attrname-format:uri.

  7. If you are adding a new attribute map, click Add. If you are updating an existing attribute map, click Update.

  8. Customize any other properties as required, and click Save Changes at the bottom of the screen.

    For in-depth information about hosted IDP and SP properties, refer to:

  9. Export the XML-based metadata from your hosted provider to share with other providers in your circle of trust.

    $ curl \
    --output metadata.xml \
    "https://<tenant-env-fqdn>/am/saml2/jsp/exportmetadata.jsp\
    ?entityid=myHostedProvider\
    &realm=/mySubRealm"

    If the remote provider has the ability to read the URL (refer to the preceding example), then you can provide the URL to the remote provider, and they can load the metadata that way instead.

Import and configure a remote IDP or SP

A remote IDP or SP is a provider outside of Identity Cloud. For example, Azure AD could be the authoritative source for a user profile in your organization. If that is the case, then Azure AD would be a remote IDP.

The following procedure provides steps for importing and configuring one or more remote IDP or SPs:

  1. Obtain the remote IDP or SP metadata as an XML-formatted file and save it onto the machine where you will be interacting with the Identity Cloud tenant. Each application has different ways to obtain the file.

  2. From the Identity Cloud admin UI, click Native Consoles > Access Management.

  3. Go to Realms > Realm Name > Dashboard, and click SAML Applications.

  4. Click the Add Entity Provider drop-down button, and click Remote.

  5. On the New Remote Entity Provider page, perform one of the following steps to import the XML file:

    1. Drag and drop the XML file into the dotted box.

    2. Click within the dotted box to open a file browser to select the XML file.

      You can import multiple remote entities in a single operation, as long as the entity ID is unique within each.

  6. If you have already created a circle of trust, you can add the remote providers into one or more of them by using the Circles of Trust property. If you have not created a circle of trust, refer to Create a circle of trust.

  7. Click Create.

  8. After you import the metadata, you can edit the configuration of an entity provider. To do this, navigate to Realms > Realm Name > Applications > Federation > Entity Providers, and select the entity provider to edit.

    The AM admin UI only displays the configuration of a single role. To switch between SP and IDP configuration for a given provider, click on the labels to select the role view:

    saml-roles

    For in-depth information about remote entity provider properties, refer to:

Copyright © 2010-2023 ForgeRock, all rights reserved.