/registerApp: Register App

URL:
https://[root]/oauth2/registerApp
Methods:
POST

Example Usage

Use dark colors for code blocksCopy
1
https://www.arcgis.com/sharing/rest/oauth2/registerApp

Description

The register app operation (POST only) registers an app item with the portal. App registration results in an APPID and APPSECRET (also known as client_id and client_secret in OAuth speak, respectively) being generated for that app. Upon successful registration, a Registered App type keyword gets appended to the app item.

Available to the item owner.

Request parameters

ParameterDetails

[Common Parameters]

For a complete listing, see Common parameters.

itemId

The ID of the item being registered. The item must be owned by the user invoking this operation, otherwise the call will be rejected.

Example:

Use dark colors for code blocksCopy
1
itemId=e52db2cdc16640a0b1c69727abdf48c8

appType

The type of app that was registered indicating whether it's a browser app, native app, server app, or a multiple interface app.

Values: browser | native | server| multiple

Example:

Use dark colors for code blocksCopy
1
appType=browser

redirect_uris

The URIs where the access_token or authorization code will be delivered upon successful authorization. The redirect_uri specified during authorization must match one of the registered URIs, otherwise authorization will be rejected.

A special value of urn:ietf:wg:oauth:2.0:oob can also be specified for authorization grants. This will result in the authorization code being delivered to a portal URL (/oauth2/approval). This value is typically used by apps that don't have a web server or a custom URI scheme where the code can be delivered.

The value is a JSON string array.

Example:

Use dark colors for code blocksCopy
1
2
3
4
[
  "https://app.foo.com",
  "urn:ietf:wg:oauth:2.0:oob"
]

httpReferrers

Referrers to which you want your tokens to be restricted to.

The value is an Array of referrers. Token will be valid for requests that have referrer value from the list specified.

Example:

Use dark colors for code blocksCopy
1
httpReferrers=["https://www.example.com"]

privileges

The registered app item's owner can provide access to specific items as a privilege. A maximum of 100 items are allowed.

Example:

Use dark colors for code blocksCopy
1
2
3
4
5
privileges=[
  "premium:user:basemaps",
  "premium:user:networkanalysis",
  "portal:app:access:item:a23adf23456sdfg2dg342344234asdf"
]

Response properties

The response represents the registered app and is the same as that of the Registered App resource.

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