OAuth 2.0 Access Tokens API

download spec authorize

post /organizations/{org_name}/oauth2/accesstokens/{access_token}

Enables you to perform one of the following tasks:

  • Approve or revoke an OAuth 2.0 access token. Set the action query parameter to approve or revoke, respectively. Optionally, set the cascade query parameter to true to cause refresh tokens associated with the access token to be affected by the same action.
  • Update the OAuth 2.0 access token attributes. Pass the attribute details in the request body. Only attributes specified in the request body are updated. Any other existing attributes are not affected.

HTTP request

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

Path Parameters

org_name (required)

string

Organization name.

access_token (required)

string

Access token.

Query Parameters

action

string

Set to approve or revoke.

cascade

string

Flag that specifies whether the refresh token associated with the access token is also approved or revoked. Set to true to approve or revoke the refresh token. Defaults to false.

Request Body

application/json
AccessTokenAttributes

Update access token attributes.

attributes

array

Attributes used to extend the default profile.

NameValue

Name/value attribute pairs.

name

string

Name of attribute.

value

string

Value of attribute.

scope

string

List of scopes associated with the access token, validated at runtime against scopes defined in API product.

Response Types

200: 

OK

400: 

Bad request

Authentication Requirements

For OAuth, enter the following in the Key field: Bearer %your-token% (see https://docs.apigee.com/api-platform/system-administration/using-oauth2#get-the-tokens)

Key location: header
Parameter name: Authorization
Available Authentication Options
  • Basic
  • OAuth

Try this API

Request parameters
org_name
access_token
action
cascade
Request body
For suggestions, press control+space or click one of the blue "add" circles.
Credentials
Multi-factor authentication is not supported.