updateOAuthApp

updateOAuthApp

Function
updateOAuthApp(requestOptionsIUpdateOAuthOptions): Promise<IOAuthApp>

Used to update an OAuth2.0 app.

Notes about redirect_uris options:

  1. Provided option will override corresponding old option.
  2. Unprovided option will not trigger corresponding option updates.
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
import { updateOAuthApp, 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"
});

updateOAuthApp({
  itemId: "xyz_itemId",
  authentication: authSession
}).then((updatedOAuthApp: IOAuthApp) => {
  // => This OAuth app will be not be updated because its redirect_uris is not provided.
  // => {redirect_uris: ["http://localhost:3000/"], item: {tags: ["xyz_tag1", "xyz_tag2"], ...}, ...}
}).catch(e => {
  // => an exception object
});
Parameters
ParameterTypeNotes
requestOptions
IUpdateOAuthOptions

Options for updateOAuthApp | updateOAuthApp(), including itemId of which OAuth app to be operated on, optional new redirect_uris and an ArcGISIdentityManager authentication session.

Returns 
Promise<IOAuthApp>

A Promise that will resolve to an IOAuthApp object representing updated OAuth app.

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