Portal security

Most ArcGIS portals contain a considerable amount of content that is not public, but is instead secured and shared with the entire organization or specific groups. To access this secured content, users must authenticate with the portal.

The portal object will have access to all the secure content for which the user has access privileges and can be used to find out more information about the user, such as the user's full name (instead of the account user name). Additionally, information about the organization such as the name, banner image, description, and so on, can be read. Apps often make use of this information when a user connects to a specific portal, to show the user organization branding and context.

Typically, the portal object with the authenticated user is cached and used throughout the app session, to provide the app with a view of a portal that is centered around a single user. When the app is restarted, the credential must be reinstated, or the user must repeat the authentication process.

Access tokens

Accessing secured content requires an access token. The most common access tokens in ArcGIS are OAuth 2.0 tokens and API keys. For information on authentication in ArcGIS Maps SDK for Kotlin, see Security and Authentication in this guide. For steps to obtain user authentication or API key credentials, see Create developer credentials.

Accessing secured content in ArcGIS Online requires that you authenticate with the portal. You can do this by creating a Portal instance with the Portal.Connection.Authenticated connection type. Then your app must apply the access token.

The workflow for accessing secured content is as follows:

1. Apply the access token in your app code.
2. Create a Portal instance with the Portal.Connection.Authenticated connection type.

Access using OAuth

When accessing secured content using OAuth 2.0 credentials, the user's ArcGIS account must be of the correct user type and have the necessary privileges.

The code below uses the function AuthenticatorState() and the composable DialogAuthenticator, both from the ArcGIS Maps SDK for Kotlin toolkit, to obtain an access token using OAuth 2.0 credentials. For information on using the toolkit authentication module in your app, see Security and authentication.

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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
@Composable
fun MapScreen3() {
    val coroutineScope = rememberCoroutineScope()

    val authenticatorState by remember { mutableStateOf(AuthenticatorState()) }

    authenticatorState.oAuthUserConfigurations = listOf(
        OAuthUserConfiguration(
            portalUrl = "https://www.arcgis.com",
            clientId = "Your client ID goes here",
            redirectUrl = "Your redirect URL goes here"
        )
    )


    connectToPortal(coroutineScope)

    DialogAuthenticator(authenticatorState = authenticatorState)

}

fun connectToPortal(coroutineScope: CoroutineScope) {
    val portal = Portal(
        url = "https://<yourorg>.maps.arcgis.com",
        connection = Portal.Connection.Authenticated
    )

}

The code is the same whether connecting to ArcGIS Online or ArcGIS Enterprise. The only difference is the URL. For information on accessing ArcGIS Enterprise, see the Getting started using ArcGIS Enterprise.

Access using an API key

An API key must have the required privileges for the content being accessed. You can apply the key to the ArcGISEnvironment class so it's available across the entire application. For information on using API Keys in your app, see Security and authentication in this guide.

For an example of API key use in an app, see any of the ArcGIS Maps SDK for Kotlin tutorials, such as Display a map.

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
84
85
86
87
88
    ArcGISEnvironment.apiKey = ApiKey.create(YOUR_ACCESS_TOKEN)