Tutorial: Create OAuth credentials for user authentication

Learn how to create an OAuth credentialOAuth credentials are an item that contains parameters required to implement user authentication or app authentication, including a client_id, client_secret, and redirect URIs. They are a type of developer credential.Learn more to set up user authenticationUser authentication is a type of authentication that allows users with an ArcGIS account to sign into an application and allow it to access ArcGIS content, services, and resources on their behalf. The typical authorization protocol used is OAuth2.0.Learn more.

OAuth credentialsOAuth credentials are an item that contains parameters required to implement user authentication or app authentication, including a client_id, client_secret, and redirect URIs. They are a type of developer credential.Learn more are required to set up user authentication. When a user signs in with user authentication, a user token is generated to authorize access to ArcGIS services on their behalf. An OAuth credential includes a client_id and a redirect_uri, which are used to initiate the authentication flow.

This tutorial shows you how to create OAuth credentials for use in user authentication.

Prerequisites

Steps

Create OAuth credentials

1. Sign in to your portal.

   • ArcGIS Location Platform: Go to https://location.arcgis.com and sign in. In the dashboard, click My portal to go to your portal.
   • ArcGIS Online: Go to https://arcgis.com and sign in.

2. In your portalArcGIS portal, also known as a portal, is a website with applications and tools that can be used to create, manage, access, and share geospatial content and data. It supports security and authentication, developer credentials, content and data service management, user and group management, and site administration. A portal can be hosted in Esri's infrastructure or your own infrastructure.Learn more, click Content > My content > New item.

3. Click Developer credentialsDeveloper credentials are a type of item in a portal that contains parameters for authentication. There are two types of developer credentials: API key credentials and OAuth credentials.Learn more.

4. Click OAuth 2.0 credentialsOAuth credentials are an item that contains parameters required to implement user authentication or app authentication, including a client_id, client_secret, and redirect URIs. They are a type of developer credential.Learn more and click Next.

Save the item

After configuring your OAuth credentials, you can save the credentials as a new itemAn item, also known as a content item, is a resource stored in a portal such as a web map, hosted layer, style, script tool, file, or notebook.Learn more.

1. Under Redirect URLs, add the URL that you want to direct users to after completing authentication. This URL varies based on your application and typically takes the format of https://<server>[:port]/authenticate (for server-based app) or https://<server>[:port]/callback.html (for browser-based app). This is a valid web page or server endpoint to which a user can be redirected after successful sign in.

   • For example, if you are running an application on https://localhost:3000, add https://localhost:3000/authenticate (for server-based app) or https://localhost:3000/callback.html (for browser-based app) to the list of redirect URLs. The exact URL depends on the name of your callback page and the programming language you are using.

2. Under Application environment, select the type of environment your application will run in. This will affect when the OAuth credentials appear in portalArcGIS portal, also known as a portal, is a website with applications and tools that can be used to create, manage, access, and share geospatial content and data. It supports security and authentication, developer credentials, content and data service management, user and group management, and site administration. A portal can be hosted in Esri's infrastructure or your own infrastructure.Learn more search results. Then, click Next.

3. In the Create developer credentials window, set the following properties:

   • Title: My OAuth credentials (for user authentication)
   • Folder: Developer credentials (Create a new folder)
   • Tags: User authentication
   • Description: Describe the application that these developer credentials will be used in.

   Click Next.

4. In the Summary window, review the properties and redirect URL you have set.

5. Click Create to create your OAuth credentialsOAuth credentials are an item that contains parameters required to implement user authentication or app authentication, including a client_id, client_secret, and redirect URIs. They are a type of developer credential.Learn more.

Copy the client ID and redirect URL

Your OAuth credentialsOAuth credentials are an item that contains parameters required to implement user authentication or app authentication, including a client_id, client_secret, and redirect URIs. They are a type of developer credential.Learn more contain a client_id parameter that is required to implement user authentication. Copy this value, as well as your provided redirect URL, and paste them into your application.

1. On the item pageAn item page is a web page in ArcGIS Online or the developer dashboard used to access and manage the properties for an item and the content it references such as a web map, hosted layer, or file.Learn more of your OAuth credentials, scroll down to Credentials.

2. Copy the Client ID value and paste it into your application.

3. Click the Manage button to go to the Settings tab.

4. Under Redirect URLs, copy the redirect URL you provided earlier. Paste it into your application.

Now you have a client ID and a redirect URL to enable user authentication in your application.