Configuring organization-specific logins, such as OpenID Connect logins, allows members of your organization to sign in to ArcGIS Enterprise using the same logins they use to access your organization's internal systems. The advantage of setting up organization-specific logins using this approach is that members do not need to create additional logins within the ArcGIS Enterprise system; instead, they can use the login that is already set up with the organization. When members sign in to ArcGIS Enterprise, they provide their organization-specific username and password into your organization's login manager, also known as your organization's identity provider (IdP). Upon verification of the member's credentials, the IdP informs ArcGIS Enterprise of the verified identity for the member who is signing in.
ArcGIS Enterprise supports the OpenID Connect authentication protocol and integrates with IdPs such as Okta and Google that support OpenID Connect.
Set up OpenID Connect logins
The process of configuring an OpenID Connect IdP with ArcGIS Enterprise is described below. Before proceeding, it is recommended that you contact the administrator of the IdP to obtain the parameters needed for configuration. You can also access and contribute to detailed third-party IdP configuration documentation in the ArcGIS/idp GitHub repository.
- Verify that you are signed in as an administrator of your organization.
- At the top of the site, click Organization and click the Settings tab.
- If you plan to allow members to join automatically, configure default settings for new members first.
If necessary, you can change these settings for specific members after they have joined the organization.
- Click New member defaults on the side of the page.
- Select the default user type and role for new members.
- Select the add-on licenses to automatically assign members when they join the organization.
- Select the groups to which members will be added when they join the organization.
- Select the member categories to which members will be added when they join the organization.
- Click Security on the side of the page.
- In the Logins section, click New OpenID Connect login.
- In the Login button label box, type the text that you want to appear on the button that members use to sign in with their OpenID Connect login.
- Choose how members with OpenID Connect logins will join your organization: automatically or added by an administrator.
The automatic option allows members to join the organization by signing in with their OpenID Connect login. The other option allows administrators to add members to the organization. If you choose the automatic option, you can still add members directly using their OpenID Connect ID. For more information, see Add members to your portal.
- In the Registered client ID box, provide the client ID from the IdP.
- For Authentication method, specify one of the following:
- Client secret—Provide the registered client secret from the IdP.
- Public key / Private key—Choose this option to generate a public key or a public key URL for authentication.
Generating a new public/private key pair invalidates any existing public/private keys. If your IdP configuration uses a saved public key instead of the public key URL, generating a new key pair will require you to update the public key in your IdP configuration to prevent sign-in disruptions.
- In the Provider scopes/permissions box, provide the scopes to send along with the request to the authorization endpoint.
Note:ArcGIS Enterprise supports scopes corresponding to the OpenID Connect identifier, email, and user profile attributes. You may use the standard value of openid profile email for scopes if it is supported by your OpenID Connect provider. Refer to your OpenID Connect provider's documentation for the supported scopes.
- In the Provider issuer ID box, provide the identifier for the OpenID Connect provider.
- Fill in the OpenID Connect IdP URLs as follows:
Refer to the well-known configuration document for the IdP—for example, in https:/[IdPdomain]/.well-known/openid-configuration—for assistance with filling in the information below.
- For OAuth 2.0 authorization endpoint URL, provide the URL of the IdP's OAuth 2.0 authorization endpoint.
- For Token endpoint URL, provide the URL of the IdP's token endpoint for obtaining access and ID tokens.
- Optionally, for JSON web key set (JWKS) URL, provide the URL of the IdP's JSON Web Key Set document.
This document contains signing keys that are used to validate the signatures from the provider. This URL is only used if the User profile endpoint URL (recommended) is not configured.
- For User profile endpoint URL (recommended), provide the endpoint for getting identity information about the user.
If you do not specify this URL, the JSON web key set (JWKS) URL is used instead.
- Optionally, for Logout endpoint URL (optional), provide the URL of the authorization server's logout endpoint.
This is used to sign out the member from the IdP when the member signs out from ArcGIS.
- Turn on the Send access token in header toggle button if you want to have the token sent in a header instead of a query string.
- Optionally, turn on the Use PKCE enhanced Authorization Code Flow toggle button.
When this option is turned on, the Proof Key for Code Exchange (PKCE) protocol is used to make the OpenID Connect authorization code flow more secure. Every authorization request creates a unique code verifier, and its transformed value, the code challenge, is sent to the authorization server to obtain the authorization code. The code challenge method used for this transformation is S256, which means that the code challenge is a Base64 URL-encoded, SHA-256 hash of the code verifier.
- Optionally, for ArcGIS username field/claim name, provide the name of the claim from the ID token that will be used to set up the ArcGIS username.
The value you provide must adhere to the ArcGIS username requirements. An ArcGIS username must contain 6 to 128 alphanumeric characters and can include the following special characters: . (dot), _ (underscore), and @ (at sign). Other special characters, nonalphanumeric characters, and spaces are not allowed.
If you specify a value with fewer than six characters, or if the value matches an existing username, numbers are added to the value. If you leave this field blank, the username is created from the prefix of the email if available; otherwise, the ID claim is used to create the username.
- When you're finished, click Save.
- Click the Configure login link next to OpenID Connect login.
- To complete the configuration process, copy the generated Login Redirect URI and Logout Redirect URI (if applicable), and add them to the list of allowed callback URLs for the OpenID Connect IdP.
Modify or remove the OpenID Connect IdP
When you've set up an OpenID Connect IdP, you can update its settings by clicking Configure login next to the currently registered IdP. Update your settings in the Edit OpenID Connect login window.
To remove the currently registered IdP, click Configure login next to the IdP and click Delete login in the Edit OpenID Connect login window.
An OpenID Connect login cannot be deleted until all members from the provider are removed.