Sign in and access your portal

You need an access tokenAn access token is an authorization string that provides access to secure ArcGIS content, data, and services. Its capabilities are determined by the privileges it supports. It is obtained by implementing API key authentication, User authentication, or App authentication.Learn more with the correct privileges for in this tutorial.

1. Go to the Create an API key tutorial and create an API keyAn API key is a long-lived access token created using API key credentials. They are valid for up to one year and are typically embedded directly into client applications.Learn more with the following privilege(s)Privileges are a set of permissions assigned to ArcGIS accounts, developer credentials, and applications that grant access to secure resources and functionality in ArcGIS.Learn more:

   • ArcGIS Online and ArcGIS Enterprise:
     • Organization (portal) operations > Administrative privileges > Content > View all
   • ArcGIS Location Platform:
     • Portal service > Administrative privileges > Content > View all

To perform the portal serviceA portal service provides the functionality to securely create, access, and manage content, data services, users, and groups in a portal. The service can be hosted by Esri or in ArcGIS Enterprise.Learn more operation in this tutorial, you need an access token from 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. It is the only supported form of authentication. The use of API keys is not supported.

Create a new 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 register the application.

1. Go to the Create OAuth credentials for user authentication tutorial to create an OAuth credential.
2. Copy the Client ID and Redirect URL from your OAuth credentials item and paste them to a safe location. They will be used in a later step.

1. Install the ArcGIS API for Python.
2. Start your Jupyter Notebook environment locally.

1. To get started, use this pen.

1. Add the following import statements to your code.

   main.py

   Use dark colors for code blocks

   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14
   15
   16
   17
   18
   
   import requests
   import json
   
   

2. Create a variable url and paste in your portal URL, appending /self at the end.

   main.py

   Use dark colors for code blocks

   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14
   15
   16
   17
   18
   
   import requests
   import json
   
   url = "https://www.arcgis.com/sharing/rest/portals/self"
   
   

3. Set the following parameters and paste in your access token in the appropriate field.

   main.py

   Use dark colors for code blocks

   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14
   15
   16
   17
   18
   
   import requests
   import json
   
   url = "https://www.arcgis.com/sharing/rest/portals/self"
   
   params = {
       "f": "json",
       "api_token": "YOUR_ACCESS_TOKEN",
   }
   
   

4. Execute the REST call and print the JSON response.

   main.py

   Use dark colors for code blocks

   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14
   15
   16
   17
   18
   
   import requests
   import json
   
   url = "https://www.arcgis.com/sharing/rest/portals/self"
   
   params = {
       "f": "json",
       "api_token": "YOUR_ACCESS_TOKEN",
   }
   
   response = requests.get(url, params=params)
   
   if response.status_code == 200:
       # Print the JSON response
       print(json.dumps(response.json(), indent=4))
   else:
       print("Failed to retrieve self info. Status code:", response.status_code)

1. Create a request block in your code using esri/request library.

   Expand

   Use dark colors for code blocks

   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
          const esriRequest = await $arcgis.import("@arcgis/core/request.js");
   
   
         });
   

   Expand

2. Create a variable url and paste in your portal URL, appending /self at the end.

   Expand

   Use dark colors for code blocks

   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
          const esriRequest = await $arcgis.import("@arcgis/core/request.js");
   
   
            const url = "https://www.arcgis.com/sharing/rest/portals/self"
   
         });
   

   Expand

3. Set the following parameters in an options object and paste in your access token in the appropriate field.

   Expand

   Use dark colors for code blocks

   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
          const esriRequest = await $arcgis.import("@arcgis/core/request.js");
   
   
            const url = "https://www.arcgis.com/sharing/rest/portals/self"
   
            const options = {
              query: {
                f: "pjson",
                token: "YOUR_ACCESS_TOKEN"
              },
              responseType: "pjson"
            };
   
         });
   

   Expand

4. Execute the REST call and print the JSON response.

   Expand

   Use dark colors for code blocks

   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
          const esriRequest = await $arcgis.import("@arcgis/core/request.js");
   
   
            const url = "https://www.arcgis.com/sharing/rest/portals/self"
   
            const options = {
              query: {
                f: "pjson",
                token: "YOUR_ACCESS_TOKEN"
              },
              responseType: "pjson"
            };
   
              esriRequest(url, options,{
              }).then((response)=>{
                const data = response.data
                console.log(data);
            })
   
         });
   

   Expand

1. To get started, use this pen.