createOAuthApp

createOAuthApp

Function
createOAuthApp(requestOptionsICreateOAuthAppOption): Promise<IOAuthApp>

Used to register an OAuth2.0 app. See the OAuth2.0 for more information.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
import { createOAuthApp, IOAuthApp } from '@esri/arcgis-rest-developer-credentials';
import { ArcGISIdentityManager } from "@esri/arcgis-rest-request";

const authSession: ArcGISIdentityManager = await ArcGISIdentityManager.signIn({
  username: "xyz_usrName",
  password: "xyz_pw"
});

createOAuthApp({
  title: "xyz_title",
  description: "xyz_desc",
  tags: ["xyz_tag1", "xyz_tag2"],
  redirect_uris: ["http://localhost:3000/"],
  authentication: authSession
}).then((registeredOAuthApp: IOAuthApp) => {
  // => {redirect_uris: ["http://localhost:3000/"], item: {tags: ["xyz_tag1", "xyz_tag2"], ...}, ...}
}).catch(e => {
  // => an exception object
});
Parameters
ParameterTypeNotes
requestOptions
ICreateOAuthAppOption

Options for createOAuthApp | createOAuthApp(), including necessary params to register an OAuth app and an ArcGISIdentityManager authentication session.

Returns 
Promise<IOAuthApp>

A Promise that will resolve to an IOAuthApp object representing the newly registered OAuth app.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close