Hide Table of Contents
esri
esri/arcgis
esri/dijit
esri/dijit/analysis
esri/dijit/geoenrichment
esri/dijit/geoenrichment/ReportPlayer
esri/geometry
esri/layers
esri/opsdashboard
esri/renderers
esri/symbols
esri/tasks
esri/tasks/datareviewer
esri/tasks/geoenrichment
esri/tasks/locationproviders
Class: OAuthInfo
[ AMD Module Require | Legacy Module Require ]
require(["esri/arcgis/OAuthInfo"], function(OAuthInfo) { /* code goes here */ });
Description
(Added at v3.10)
This class contains information about an OAuth configuration.
See also
Samples
Search for samples that use this class.Constructors
| Name | Summary |
|---|---|
| new OAuthInfo(params) | Creates a new OAuthInfo given the specified parameters. |
Properties
| Name | Type | Summary |
|---|---|---|
| appId | String | The registered application Id. |
| authNamespace | String | Applications with the same value will share the stored token on the same host. |
| expiration | Number | The number of minutes the token that the token is valid. |
| locale | String | The locale for the OAuth sign in page. |
| minTimeUntilExpiration | Number | The minimum time in minutes before a saved token is due to expire that it should still be considered valid for use. |
| popup | Boolean | Set to true to show the OAuth sign in page in a popup window. |
| popupCallbackUrl | String | Applicable if working with the popup user-login workflow. |
| popupWindowFeatures | String | The window features passed to window.open(). |
| portalUrl | String | The ArcGIS for Portal URL. |
Methods
| Name | Return type | Summary |
|---|---|---|
| toJson() | Object | Returns an easily serializable object representation of the OAuthInfo. |
Constructor Details
Creates a new OAuthInfo given the specified parameters.
Parameters:
< |
Required | Various options to configure the OAuthInfo object. All the properties can be passed into the params object. |
params properties: < |
Required | The registered application Id. |
< |
Optional | Applications with the same value will share the stored token on the same host. The default value is "/" (forward slash). |
< |
Optional | The number of minutes the token will be valid for. The default is 20160 (two weeks). |
< |
Optional | The locale for the OAuth sign in page. The default locale is based on your browser/OS and the locale for the organization that you are using. You can use the locale property to change this. The locale needs to follow the language dash country code syntax supported by ArcGIS.com. See localization for details. |
< |
Optional | The minimum time in minutes before a saved token is due to expire that it should still be considered valid for use. The default value is 30. |
< |
Optional | Set to true to show the OAuth sign in page in a popup window. The default value is "false". |
< |
Optional | The relative page URL for the user to be sent to from the OAuth sign in page. The default value is oauth-callback.html. You can download this here. |
< |
Optional | The window features passed to window.open(). The default value is "height=490,width=800,resizable,scrollbars,status. |
< |
Optional | The ArcGIS for Portal URL. The default value is "https://www.arcgis.com." |
Sample:
require([
"esri/arcgis/OAuthInfo", ...
], function(OAuthInfo, ... ) {
var oAuthInfo = new OAuthInfo({
appId: "", //required parameter
... //specify optional parameters if needed
}); Property Details
<String
StringThe registered application Id.
<String
StringApplications with the same value will share the stored token on the same host.
Default value:
/ (forward slash)<Number
NumberThe number of minutes the token that the token is valid.
Default value:
20160 (two weeks).<String
StringThe locale for the OAuth sign in page. The default locale is based on your browser/OS and the locale for the organization that you are using. You can use the locale property to change this. The locale needs to follow the language dash country code syntax supported by ArcGIS.com. See localization for details.
Default value:
Based on your browser/OS and the locale for the organization that you are using.<Number
NumberThe minimum time in minutes before a saved token is due to expire that it should still be considered valid for use.
Default value:
30 minutes<Boolean
BooleanSet to true to show the OAuth sign in page in a popup window.
Known values:
true | falseDefault value:
false<String
StringApplicable if working with the popup user-login workflow. This is a relative page URL that redirects the user back to the secured application after successful login. You can download the default page here.
Default value:
oauth-callback.html.<String
StringThe window features passed to window.open().
Default value:
height=490,width=800,resizable,scrollbars,statusMethod Details