/apps/[clientID]: Registered App

URL:: https://[root]/oauth2/apps/[clientID]
Methods:: POST

Example usage

URL for Registered App

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

Description

An app registered with the portal. An app item can be registered by invoking the register app operation. Every registered app gets an App ID and App Secret which in OAuth speak are known as client_id and client_secret respectively.

The app owner has access to the registered app resource. This would include the organization administrator as well.

Request Parameters

Parameter	Details
`[Common Parameters]`	For a complete listing, see Common parameters.

Response Properties

Property	Details
`client_id`	The ID of the registered application. Also referred to as APPID.
`client_secret`	The secret of the registered application. Also referred to as APPSECRET.
`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 to upon successful authorization. The `redirect_uri` specified during authorization must be 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 applications that don't have a web server or a custom URI scheme to deliver the code to. 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" ]`
`apiToken1Active`	Indicates if the API token1 is active. If `false`, the API token1 is either expired or invalidated. Values: `true` \| `false`
`apiToken2Active`	Indicates if the API token2 is active. If `false`, the API token2 is either expired or invalidated. Values: `true` \| `false`
`created`	The date when the app was created (in UNIX time in milliseconds).
`modified`	The date when the app was last modified (in UNIX time in milliseconds).

JSON Response syntax

Use dark colors for code blocksCopy
{
  "itemId": "<itemId>",
  "client_id": "<client_id>",
  "client_secret": "<client_secret>",
  "appType": "<appType>",
  "redirect_uris": [
    "<redirect_uri1>",
    "<redirect_uri2>"
  ],
  "registered": <registered>,
  "modified": <modified>,
  "httpReferrers": ["<https://www.example.com>"],
  "privileges": [
    "<privilege1>",
    "<privilege2>",
    "portal:app:access:item:<itemID>"
  ],
  "apiToken1Active": <true | false>,
  "apiToken2Active": <true | false>
}

JSON Response example

Use dark colors for code blocksCopy
{
  "itemId": "e52db2cdc16640a0b1c69727abdf48c8",
  "client_id": "GGjeDjEY6kKEiDmX",
  "client_secret": "e2b8958384c74d3a9f09e988d782b473",
  "appType": "browser",
  "redirect_uris": [
    "https://*.arcgis.com",
    "urn:ietf:wg:oauth:2.0:oob"
  ],
  "registered": 1380561095000,
  "modified": 1380561095000,
  "httpReferrers": ["https://www.arcgis.com"],
  "privileges": [
    "portal:user:createItem",
    "portal:admin:updateItems",
    "portal:app:access:item:a23adf23456sdfg2dg342344234asdf"
  ],
  "apiToken1Active": true,
  "apiToken2Active": false
}