Get External Client App OAuth usage information and revoke tokens through the Connect REST API. The Connect API returns information about the external client apps that users in your org are connecting to, a list of all OAuth users for an app, or the tokens for a given app and user. If you want to revoke access to an external client app, use the Connect API usage resources to revoke a specific token, all tokens associated with an app, or the tokens associated with a specific user.
When working with connected apps, system admins access usage information through the Usage page in Setup. Usage information is available for external client apps only through the Connect REST API, because external client apps don’t have a UI component.
Connect REST API
Access the OAuth Usage resources with the Connect REST API. An External Client App admin for a subscriber org doesn’t need any special permissions to access the Usage resources.
OAuth Usage Features
There are five URIs for OAuth usage in the Connect API. Each of the five endpoints supports either a GET method, a DELETE method, or both a GET and DELETE method. Use these components to monitor app usage and revoke tokens. Details about these resources can be found in the Connect REST API Developer Guide.
| URI | Method | Description |
|---|---|---|
| /apps/oauth/usage/ | GET | Lists all the external client apps for the current org. See OAuth Usage. |
| /apps/oauth/usage/<appIdentifier>/users | GET | Lists all users for the external client app indicated by the app ID. See OAuth Users by App ID. |
| /apps/oauth/usage/<appIdentifier>/<userIdentifier>/tokens | GET | Lists all tokens for a user of the external client app. See Refresh Token by User and App. |
| /apps/oauth/usage/<appIdentifier>/<userIdentifier>/tokens | DELETE | Revokes all tokens for a user of the external client app. See Refresh Token by User and App. |
| /apps/oauth/usage/<appIdentifier>/tokens | DELETE | Revokes all tokens available for the external client app. See Refresh Token by App ID. |
| /apps/oauth/usage/tokens/<tokenIdentifier> | DELETE | Revokes one token. See OAuth Refresh Token. |