—Rate this article—
 

Beta Release of SmartDocs

1. In the Resource URL, replace any values enclosed in "{}", such as your organization name.
2. Set the Basic Authentication credentials. These are your Edge credentials (user must be in the Org Admin role).
3. Tweak the Request Body as needed (if a body is needed).
4. Send the live request to Edge and view the response! You can also view Request data.

Revoke OAuth 2.0 Access Token by End User ID or App ID

Resource Summary

Auth Type

BASICAUTH,

Content Type

application/json, text/xml

Category

OAuth 2.0 Access Token,

revokeOAuth2AccessTokenbyEndUserIDorAppID

POST

Revoke OAuth 2.0 Access Token by End User ID or App ID

Revokes an OAuth 2.0 access token by end user ID, app ID, or both. Only users with the orgadmin or opsadmin role assigned can make this call.

Use of this API call requires some setup. See Enable retrieval and revocation of OAuth 2.0 access tokens by end user ID, app id, or both.

Resource URL

https://api.enterprise.apigee.com/v1 /organizations/{org_name}/oauth2/revoke

    Header Parameters

  • Name
    Value
    Description
  • Content-Type
    (required)
    Specify the Content-Type.
  • enduser
    Use to revoke OAuth 2.0 access tokens associated with a specific end user. This is an end user of one of your developer apps. This value is not required, but you must query by "enduser" and/or "app".
  • app
    Use to revoke OAuth 2.0 access tokens associated with a specific developer app ID (UUID). This is an app developed by one of your developers. This value is not required, but you must query by "enduser" and/or "app".

org_name Mention the organization name true

org_name Mention the organization name true

Basic Auth

OAuth 2

Custom Token

Reset

Make a request and see the response.

Make a request and see the response.

Response Payload Elements

When your API request has been successfully sent, the HTTP status code will be "202 Accepted" and the response will display the number of OAuth 2.0 tokens that were submitted for revocation.

The "202 Accepted" status does not mean that the revocation has been completed. For example, you may do a GET for access tokens after performing a revoke and see an OAuth 2.0 access token that should have been revoked. This may just mean that the revocation process is still in-progress. The processing time depends on the number of access tokens being revoked.
application/xml

Working...

Help or comments?

  • Something's not working: See Apigee Support
  • Something's wrong with the docs: Click Send Feedback in the lower right.
    (Incorrect? Unclear? Broken link? Typo?)