Learn how to use ArcGIS Maps SDK for Javascript to create an ArcGIS identity, also known as named user login .
If your application needs access to your users' secure content through ArcGIS or if you are distributing your app through ArcGIS Marketplace , you must implement authentication with an ArcGIS identity. This allows individual users with an ArcGIS Online or ArcGIS Enterprise account to authorize your app to use the content and services to which they have access; it also uses their credits for any paid premium content and services .
Prerequisites You need an ArcGIS account to register a new application and obtain its client_. See the register your application tutorial . If you do not have an ArcGIS account you can sign up for a free ArcGIS Developer account .
When registering your application you will need to configure a redirect URL that will point to the URL where you are hosting your application. Generally this will be a local web server such as http:.
Steps Create a new pen Go to CodePen to create a new pen for your mapping application. Add the HTML In Codepen > HTML , add HTML and CSS to create a page with <button> and <pre> elements to allow the user to sign in, sign out, and to display user credentials.
Expand
Use dark colors for code blocks
Add line. Add line. Add line. Add line. Add line. Add line. Add line. Add line. Add line. Add line. Add line. Add line. Add line. Add line. Add line. Add line. Add line. Add line. Add line. Add line. Add line. Add line. Add line. Add line. Add line. Add line. Add line.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
< html >
< head >
< meta http-equiv = "Content-Type" content = "text/html; charset=utf-8" />
< meta name = "viewport" content = "initial-scale=1, maximum-scale=1,user-scalable=no" />
< title > ArcGIS Maps SDK for JavaScript Tutorials: Authenticate with an ArcGIS identity </ title >
< style >
html ,
body {
font-size : 150% ;
margin : 10vh 10vw ;
}
</ style >
</ head >
< body >
< button id = "sign-in" class = "btn btn-primary" > Sign In </ button >
< button id = "sign-out" class = "btn btn-primary" > Sign Out </ button >
< pre > < code id = "results" > </ code > </ pre >
</ body >
</ html >
Reference the API In the <head> tag, add references to the CSS file and JS library.
Expand
Use dark colors for code blocks
Add line. Add line.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
< head >
< meta http-equiv = "Content-Type" content = "text/html; charset=utf-8" />
< meta name = "viewport" content = "initial-scale=1, maximum-scale=1,user-scalable=no" />
< title > ArcGIS Maps SDK for JavaScript Tutorials: Authenticate with an ArcGIS identity </ title >
< link rel = "stylesheet" href = "https://js.arcgis.com/4.26/esri/themes/light/main.css" >
< script src = "https://js.arcgis.com/4.26/" > </ script >
< style >
html ,
body {
font-size : 150% ;
margin : 10vh 10vw ;
}
</ style >
</ head >
Add modules In the <head> tag, add a <script> tag and a require statement to load the PortalOAuthIdentity
More info The ArcGIS Maps SDK for JavaScript is available as AMD modules and ES modules , but this tutorial is based on AMD. The AMD require function uses references to determine which modules will be loaded – for example, you can specify "esri/Map" for loading the Map module. After the modules are loaded, they are passed as parameters (e.g. Map) to the callback function where they can be used in your application. It is important to keep the module references and callback parameters in the same order. For more information on the different types of modules, visit the Introduction to Tooling guide topic.
Expand
Use dark colors for code blocks
Add line. Add line. Add line. Add line. Add line. Add line. Add line. Add line. Add line. Add line.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
< script >
require ([
"esri/portal/Portal" ,
"esri/identity/OAuthInfo" ,
"esri/identity/IdentityManager"
], function ( Portal, OAuthInfo, esriId ) {
});
</ script >
Register credentials with Identity Manager From the ArcGIS Developer dashboard, OAuth 2.0 tab , copy your application's client_.
Create an OAuthappclient_ before you register it with Identity
Expand
Use dark colors for code blocks
Add line. Add line. Add line. Add line. Add line.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
require ([
"esri/portal/Portal" ,
"esri/identity/OAuthInfo" ,
"esri/identity/IdentityManager"
], function ( Portal, OAuthInfo, esriId ) {
const info = new OAuthInfo({
appId : "YOUR-CLIENT-ID" ,
popup : false // the default
});
esriId.registerOAuthInfos([info]);
Handle sign in Once you have registered your client_ with IdentityArcGIS Maps SDK for JavaScript will automatically prompt a user to authorize your application whenever it accesses a service that requires authentication. Create a sign in experience by accessing the users profiles with the Portal
Create a handle function to be called when the user authorizes your application and then load the Portalfull and username on the page.
Expand
Use dark colors for code blocks
Add line. Add line. Add line. Add line. Add line. Add line. Add line. Add line. Add line.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
const info = new OAuthInfo({
appId : "YOUR-CLIENT-ID" ,
popup : false // the default
});
esriId.registerOAuthInfos([info]);
function handleSignedIn ( ) {
const portal = new Portal();
portal.load().then( () => {
const results = { name : portal.user.fullName, username : portal.user.username };
document .getElementById( "results" ).innerText = JSON .stringify(results, null , 2 );
});
}
Call the checkhandle function.
More info checkhttps: is the easiest way to fully authenticate a user.
Expand
Use dark colors for code blocks
Add line. Add line. Add line. Add line. Add line. Add line.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
const info = new OAuthInfo({
appId : "YOUR-CLIENT-ID" ,
popup : false // the default
});
esriId.registerOAuthInfos([info]);
esriId
.checkSignInStatus(info.portalUrl + "/sharing" )
.then( () => {
handleSignedIn();
})
function handleSignedIn ( ) {
const portal = new Portal();
portal.load().then( () => {
const results = { name : portal.user.fullName, username : portal.user.username };
document .getElementById( "results" ).innerText = JSON .stringify(results, null , 2 );
});
}
Handle sign out Create a handle function when a user's credentials are destroyed.
Expand
Use dark colors for code blocks
Add line. Add line. Add line.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
function handleSignedIn ( ) {
const portal = new Portal();
portal.load().then( () => {
const results = { name : portal.user.fullName, username : portal.user.username };
document .getElementById( "results" ).innerText = JSON .stringify(results, null , 2 );
});
}
function handleSignedOut ( ) {
document .getElementById( "results" ).innerText = 'Signed Out'
}
Append a catch statement to call the handle function when the user signs out.
Expand
Use dark colors for code blocks
Add line. Add line.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
esriId
.checkSignInStatus(info.portalUrl + "/sharing" )
.then( () => {
handleSignedIn();
})
.catch( () => {
handleSignedOut();
});
Add event listeners Call the getsign-in button.
Expand
Use dark colors for code blocks
Add line. Add line. Add line. Add line.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
.catch( () => {
handleSignedOut();
});
document .getElementById( "sign-in" ).addEventListener( "click" , function ( ) {
esriId.getCredential(info.portalUrl + "/sharing" );
});
Call the destroysign-out button before reloading the page.
Expand
Use dark colors for code blocks
Add line. Add line. Add line. Add line.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
.catch( () => {
handleSignedOut();
});
document .getElementById( "sign-in" ).addEventListener( "click" , function ( ) {
esriId.getCredential(info.portalUrl + "/sharing" );
});
document .getElementById( "sign-out" ).addEventListener( "click" , function ( ) {
esriId.destroyCredentials();
window .location.reload();
});
Run the App You should now have an application that can check for credentials using OAuth 2.0.