A portal is a website with tools that can be used to create, manage, access, and share geospatial content
In addition, a portal includes security and authentication capabilities, comprised of access controls for that portal’s content, as well as authentication services for apps and users to gain access to a portal’s secured content and tools.
As a developer, you can use a portal to manage developer credentials
ArcGIS Location Platform
ArcGIS Online
With ArcGIS Online you can do things like:
- Create web maps
- Web enable your data
- Control how your maps, data, and applications are shared
- Find relevant and useful basemaps, data, and configurable GIS resources
- Manage content and users in your organization
Once hosted, you can access your data as services from your ArcGIS Maps SDK for JavaScript
ArcGIS for organizations
To access all the capabilities of ArcGIS Online, your organization
Learn more about ArcGIS for organizations at ArcGIS Online.
ArcGIS Location Platform
ArcGIS Location Platform
For more information on getting started with the JavaScript Maps SDK and ArcGIS Location Platform, see the ArcGIS Location Platform guide.
Portal items, users, and groups
ArcGIS Online is an information portal and is represented in the API by the Portal class.
When you sign in to ArcGIS Online with an organization
Portal items
ArcGIS Online and ArcGIS Enterprise can store many types of content. See supported items in the ArcGIS documentation for an exhaustive list. Perhaps the type most commonly used by apps is a web map—a JSON description of the data in a map, along with other display and behavioral properties. Other types include tile packages, feature collections, and services. Some types, such as globe documents and map templates, may only be relevant to desktop systems. Although you can access these types of data using ArcGIS Runtime API, you may not be able to use them on a mobile device.
Portal users
A registered user of a portal is represented in the API by the PortalUser class. When you sign in to a portal, you get information relating to the authenticated user from the portal class. Several options are available for signing in to a portal, such as OAuth 2.0, network credentials, API keys, and tokens. Two authentication patterns are available, these are:
Portal groups
Groups are a way to collaborate with other users who share a common interest. A user can create groups, join groups, and share items with those groups. Groups have titles, descriptions, thumbnails, and unique IDs to help users identify them. The sharing model within ArcGIS Online is based on groups. Groups are represented in the API by the PortalGroup class.
Connect to public content and services
To connect to ArcGIS Online and access public content anonymously, you can begin by creating a portal, without authenticating with the portal.
var portal = new Portal(); // Defaults to www.arcgis.comportal.authMode = "anonymous"; // Set this for anonymous access (no login required)portal.load().then(() => { // Do something here});From here, you can access public content. For example, you can display a web map, or add a hosted layer from a PortalItem into your map. You can also search for content such as web maps, map services, groups, and users.
Some organizations share content publicly and allow anonymous access to that content; connect to publicly accessible content from such organizations by specifying the organization URL. For example:
var portal = new Portal("https://[organization-name].maps.arcgis.com");Connect to secured content and services
Web applications that target organization
// Register the IdentityManager with an instance of a registered OAuthInfo objectvar info = new OAuthInfo({ // Swap this ID out with a registered application's client ID appId: "<insert appID here>",});
identityManager.registerOAuthInfos([info]);
var portal = new Portal(); // Optionally, specify the url instead of the default www.arcgis.comportal.authMode = "immediate"; // Setting authMode to immediate signs the user in once loaded
// Load portalportal.load().then(() => { // Do something once loaded});The portal object now has access to all the secure content for which the user has access rights and can be used to find out more information about the user, such as the user’s name, instead of the account user name. Additionally, information about the organization such as the name, banner image, description, and so on, can be displayed in the OAuth sign-in window. Web applications often make use of this information when a user connects to a specific portal, to show the user organization branding and context.
To access secure content, a web application needs to provide a way to sign in to the platform, a process often known as authentication. The recommended approach for authenticating a user known to the platform is to implement user authentication with OAuth 2.0. Web applications that target users who are unknown to ArcGIS can authenticate with the platform on behalf of the user by using an application login. OAuth 2.0 authentication is handled automatically by the IdentityManager class. If the IdentityManager has registered OAuthInfo and detects a secure resource, a challenge for authentication is issued. The user is shown a web form, allowing them to login using their platform credentials.
Typically, the portal object with the authenticated user is used throughout the session, to provide the web application with a view of a portal that is centered around a single user. A credential is generated once a user signs in and cached within their session for a default of two weeks. This can be updated by setting the OAuthInfo.expiration property. In addition, it is good practice to call IdentityManager.destroyCredentials() once finished.
If you do not wish to sign in each time the application launches, the OAuth login page provides an option to keep the user signed in. Doing this stores the token information in the browser’s local storage.
ArcGIS Enterprise
ArcGIS Enterprise provides you with the same core capabilities as ArcGIS Online although it can be installed and hosted on your own premises and behind a firewall for controlled distribution of content.
Connect to ArcGIS Enterprise portal
Connecting to an instance of ArcGIS Enterprise portal is done in a very similar way to connecting to ArcGIS Online and is represented in the API by the same Portal class. Set the portalUrl to the Enterprise portal website, along with an appropriate credential or authentication valid on that portal, or no credential or authentication if accessing public content anonymously.
// Set the default portalUrl value to the hostname of the on-premise portalconfig.portalUrl = "https://myHostName.esri.com/arcgis";// Create the portal instancevar portal = new Portal(); // Takes the default set in the configArcGIS Server
ArcGIS Server is a component of ArcGIS Enterprise. It is a complete and integrated server-based GIS, which allows you to publish various types of GIS services. These services can be used by a variety of clients, including web applications written using the ArcGIS Maps SDK for JavaScript
Discover content and services on ArcGIS Server
Use the ArcGIS Services Directory to browse the available services on an ArcGIS Server site. Open the REST Services home page in a browser. For example, you can access an Esri-hosted server for various test services.
Please note, that these services are provided for testing and development purposes only. They should not be used on production environments.
Contact your ArcGIS Server system administrator if you’re uncertain about the server URL or ArcGIS instance.
Connect to ArcGIS Server
Connecting to ArcGIS Server is a little different from connecting to portals. Instead of connecting to the portal itself, you pass the URL of the service you want to use to a class designed to work with that service type.
For example, you can create a map layer by passing in the URL to a dynamic map service:
var maplayer = new MapImageLayer();maplayer.url = "http://sampleserver6.arcgisonline.com/arcgis/rest/services/Census/MapServer";If you need to get access to the individual layers within this map service, you can access them via the MapImageLayer.sublayers property.
// Only includes the first sublayer from the map servicevar maplayer = new MapImageLayer({ url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/USA/MapServer", sublayers: [ { id: 0, // This accesses the first layer in the service }, ],});You can also work with the individual FeatureLayer of the service.
var featurelayer = new FeatureLayer({ url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/USA/MapServer/0",});The above are just a couple ways to access ArcGIS Server services directly within the ArcGIS Maps SDK for JavaScript
Similar to working with ArcGIS Online or ArcGIS Enterprise hosted services, if the service is secured, valid credentials or authentication is required to access it.
Learn more about ArcGIS for Server
Authentication
Your web application may need to access secured resources that are restricted to authorized users. For example, your organization
Additional Resources
The following are additional resources that provide information on the various topics discussed above.
- ArcGIS REST API
- Services reference - REST API
- Working with users, groups, and items - REST API
- Authentication and secure resources
- Developers help - Authentication in ArcGIS
- Core API Reference - IdentityManager
- Core API Reference - OAuthInfo
A listing of samples working with some of the concepts discussed above.
- Sample - Create a layer from a portal item
- Sample - Load portal items via drag & drop
- Sample - Load a basic WebMap
- Sample - Load a basic web scene
- Sample - Query portal items using OAuth 2.0: OAuth 2.0 user authentication approach
- Sample - Directions widget: Application login approach (can use either OAuth 2.0 or ArcGIS Tokens authentication with this)
- Sample - Route: Application login approach (can use either OAuth 2.0 or ArcGIS Tokens authentication with this)