Configure OpenAM

You can configure OpenAM 10.1.0 and later versions as your identity provider (IDP) for enterprise logins in Portal for ArcGIS. The configuration process involves two main steps: registering your enterprise identity provider with Portal for ArcGIS and registering Portal for ArcGIS with the enterprise identity provider.

Optionally, you can provide metadata to the portal about the enterprise groups in your identity store. This allows you to create groups in the portal that leverage the existing enterprise groups in your identity store. When members log in to the portal, access to content, items, and data is controlled by the membership rules defined in the enterprise group. If you do not provide the necessary enterprise group metadata, you'll still be able to create groups. However, membership rules will be controlled by Portal for ArcGIS, not the identity store.

Required information

Portal for ArcGIS requires certain attribute information to be received from the identity provider when a user logs in using enterprise logins. NameID is a mandatory attribute that must be sent by your identity provider in the SAML response to make the federation with Portal for ArcGIS work. When a user from the IDP logs in, a new user with the user name NameID will be created by Portal for ArcGIS in its user store. The allowed characters for the value sent by the NameID attribute are alphanumeric, _ (underscore), . (dot), and @ (at sign). Any other characters will be escaped to contain underscores in the user name created by Portal for ArcGIS.

Portal for ArcGIS supports flow-in of the givenName and email address attributes of the enterprise login from the enterprise identity provider. When a user signs in using an enterprise login, and if Portal for ArcGIS receives attributes with the names givenname and email or mail (in any case), Portal for ArcGIS populates the full name and the email address of the user account with the values received from the identity provider. It's recommended that you pass in the email address from the enterprise identity provider so the user can receive notifications.

Register OpenAM as the enterprise identity provider with Portal for ArcGIS

1. Sign in to the portal website as an administrator of your organization and click My Organization > Edit Settings > Security.
2. In the Enterprise Logins section, click the Set Identity Provider button and enter your organization's name in the window that appears (for example, City of Redlands). When users access the portal website, this text displays as part of the SAML sign in option (for example, Using your City of Redlands account).

   Note:

   You can only register one enterprise identity provider for your portal.

3. Choose if your users will be able to join the organization Automatically or After you add the accounts to the portal. Selecting the first option enables users to sign in to the organization with their enterprise login without any intervention from an administrator. Their account is registered with the organization automatically the first time they sign in. The second option requires the administrator to register the necessary accounts with the organization using a command line utility or sample Python script. Once the accounts have been registered, users will be able to sign in to the organization.

   Tip:

   It's recommended that you designate at least one enterprise account as an administrator of your portal and demote or delete the initial administrator account. It is also recommended that you disable the Create an account button and sign-up page (signup.html) in the portal website so people cannot create their own accounts. For full instructions, see Configuring a SAML-compliant identity provider with your portal.

4. Provide metadata information for the identity provider using one of the three options below:
   • URL—Choose this option if the URL of OpenAM federation metadata is accessible by Portal for ArcGIS. The URL is usually http(s)://<host>:<port>/openam/saml2/jsp/exportmetadata.jsp.

     Note:

     If your enterprise identity provider includes a self-signed certificate, you may encounter an error when attempting to specify the HTTPS URL of the metadata. This error occurs because Portal for ArcGIS cannot verify the identity provider's self-signed certificate. Alternatively, use HTTP in the URL, one of the other options below, or configure your identity provider with a trusted certificate.

   • File—If the URL is not accessible by Portal for ArcGIS, save the metadata obtained from the URL above as an XML file and upload the file.
   • Parameters—Choose this option if the URL or file is not accessible. Enter the values manually and supply the requested parameters: login URL and certificate. Contact your OpenAM administrator to obtain these.
5. Configure the advanced settings as applicable:
   • Encrypt Assertion—Select this option if OpenAM will be configured to encrypt SAML assertion responses.
   • Enable Signed Request—Select this option to have Portal for ArcGIS sign the SAML authentication request sent to OpenAM.
   • Entity ID—Update this value to use a new entity ID to uniquely identify your portal to OpenAM.

   The Encrypt Assertion and Enable Signed Request settings use the certificate samlcert in the portal keystore. To use a new certificate, delete the samlcert certificate, create a new certificate with the same alias (samlcert) following the steps in Import a certificate into the portal, and restart the portal.

   Note:

   Currently, Propagate logout to Identity Provider and Logout URL are not supported.

6. Optionally provide metadata to the portal about the enterprise groups in the identity store:
   1. Sign in to the ArcGIS Portal Directory as an administrator of your organization. The URL is in the format https://webadaptorhost.domain.com/webadaptorname/portaladmin.
   2. Click Security > Config > Update Identity Store.
   3. Place the group configuration JSON in the Group store configuration (in JSON format) text box.

      • If your identity store is Windows Active Directory, copy the following text and alter it to contain the information specific to your site:

        {
          "type": "WINDOWS",
          "properties": {
            "isPasswordEncrypted": "false",
            "userPassword": "secret",
            "user": "mydomain\\winaccount"
          }
        }

        In most cases, you will only need to alter values for the user and userPassword parameters. Although you type the password in clear text, it will be encrypted when stored in the portal's configuration directory or viewed. The account you use for the user parameter only needs permissions to look up the names of Windows groups on the network. If possible, use an account whose password does not expire.

      • If your identity store is LDAP, copy the following text and alter it to contain the information specific to your site:

        {
          "type": "LDAP",
          "properties": {
            "userPassword": "secret",
            "isPasswordEncrypted": "false",
            "user": "uid=admin,ou=system",
            "ldapURLForUsers": "ldaps://bar2:10636/ou=users,ou=ags,dc=example,dc=com",
            "ldapURLForRoles": "ldaps://bar2:10636/dc=example,dc=com",
            "usernameAttribute": "cn",
            "caseSensitive": "false",
            "userSearchAttribute": "cn",
            "memberAttributeInRoles": "member",
            "rolenameAttribute":"cn"
          }
        }

        In most cases, you'll only need to alter values for the user, userPassword, ldapURLForUsers, and ldapURLForRoles parameters. The URL to your LDAP will need to be provided by your LDAP administrator.

        In the above example, the LDAP URL refers to users within a specific OU (ou=users). If users exist in multiple OUs, the LDAP URL can point to a higher level OU or even the root level if needed. In that case, the URL would instead look like this:

        "ldapURLForUsers": "ldaps://bar2:10636/dc=example,dc=com",

        The account you use for the user parameter needs permissions to look up the names of groups in your organization. Although you type the password in clear text, it will be encrypted when stored in the portal's configuration directory or viewed.

        If your LDAP is configured to be case insensitive, set the caseSensitive parameter to false.
   4. When you finish entering the JSON for the user store configuration, click Update Configuration to save your changes and restart the portal.

Register Portal for ArcGIS as the trusted service provider with OpenAM

1. Configure a hosted identity provider in OpenAM.
   1. Sign in to the OpenAM administration console. This is usually available at http://servername:port/<deploy_uri>/console.
   2. On the Common Tasks tab, click Create Hosted Identity Provider.
   3. Create a hosted identity provider and add it to a Circle of Trust. You can add it to an existing circle of trust if you already have it or create a new circle of trust.
   4. By default, the hosted identity provider works with OpenDJ, the embedded user store that comes with OpenAM. If you want to connect OpenAM to any other user stores such as Active Directory, you need to create a new data source on the Access Control tab of the main OpenAM administration console.
2. Configure Portal for ArcGIS as a trusted service provider with OpenAM.
   1. Obtain the metadata file of your portal and save it as an XML file.

      To get the metadata file, sign in as an administrator of your organization and open your organization page. Click the Edit Settings button, click the Security tab, and in the Enterprise Logins section, click the Get Service Provider button.

   2. In the OpenAM administration console under Common Tasks, click Register Remote Service Provider.
   3. Select the File option for the metadata and upload the metadata XML file saved in the previous step.
   4. Add this service provider to the same circle of trust to which you added your identity provider.
3. Configure the NameID format and attributes that OpenAM needs to send to Portal for ArcGIS after authenticating the user.
   1. In the OpenAM administration console, click the Federation tab. The tab contains the circle of trust you previously added and the service and identity providers.
   2. Under Entity Providers, click your identity provider.
   3. On the Assertion Content tab, under Name ID Format, verify that urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified is listed at the top. This is the format of NameID that Portal for ArcGIS will request in its SAML request to OpenAM.
   4. Under Name ID Value Map, map an attribute from the user's profile, such as mail or upn, that will be returned as NameID to Portal for ArcGIS after the user is authenticated.

      Example: urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified =upn

   5. Click the Assertion Processing tab in the identity provider. Under Attribute Mapper, configure attributes from the user profile that you want to be sent to Portal for ArcGIS.

      Portal for ArcGIS supports flow-in of the givenName and email address attributes of the enterprise login from the enterprise identity provider. When a user signs in using an enterprise login and if Portal for ArcGIS receives attributes with the names givenname and email or mail (in any case), Portal for ArcGIS populates the full name and the email address of the user account with the values received from the identity provider.

      It is recommended that you pass in the email address from the enterprise identity provider to Portal for ArcGIS. This helps if the user later becomes an administrator. Having an email address in the account entitles the user to receive notifications regarding any administrative activity and send invitations to other users to join the organization.

      Click Save to save the NameID format and the attribute content changes.

   6. On the Federation tab of the OpenAM administration console, browse to the Portal for ArcGIS service provider under Entity Providers.
   7. On the Assertion Content tab, under Encryption, select the Assertion option if you chose the advanced setting Encrypt Assertion when registering OpenAM as the enterprise identity provider with Portal for ArcGIS.
   8. Under Name ID Format, verify that urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified is listed at the top. This is the format of NameID that Portal for ArcGIS will request in its SAML request to OpenAM..
   9. Click the Assertion Processing tab in the identity provider. Under Attribute Mapper, configure attributes from the user profile that you want to be sent to Portal for ArcGIS.
   10. Click Save to save the Name ID Format and the attribute content changes.
4. Restart the web server where OpenAM is deployed.