SetOAuthV2Info policy

This pageapplies toApigee andApigee hybrid.

View Apigee Edge documentation.

The SetOAuthV2Info policy lets you add or update custom attributes associated with an access token. Custom attributes might include things like department name, a customer ID, or a session identifier. See alsoCustomizing Tokens and Authorization Codes.

You can only add or modify custom attributes. You cannot use this policy to change fields like scope, status, expires_in, developer_email, client_id, org_name, or refresh_count. If an attribute already exists, this policy updates it. If it does not exist, the policy adds it. The access token referenced must be valid and in an approved state.

This policy is anExtensible policy and use of this policy might have cost or utilization implications, depending on your Apigee license. For information on policy types and usage implications, seePolicy types.

Samples

Basic example

Below is an example policy used to update an OAuth 2.0 access token. The example below locates the access token on the request message by looking for a query parameter calledaccess_token. When an access token is presented by a client app, the policy below will locate the access token in the query parameter. It will then update the access token's profile. It adds a custom property calleddepartment.id to the profile.

<SetOAuthV2Info name="SetOAuthV2Info">  <AccessToken ref="request.queryparam.access_token"></AccessToken>  <Attributes>    <Attribute name="department.id" ref="request.queryparam.department_id"></Attribute>  </Attributes></SetOAuthV2Info>
Note: If an attribute already exists in the access token profile, then it will be updated with the new value in the policy. If an attribute does not exist, then the attribute will be added to the access token's profile.

Element Reference

The element reference describes the elements and attributes of the SetOAuthV2 policy.

<?xmlversion="1.0"encoding="UTF-8"standalone="yes"?><SetOAuthV2Infoasync="false"continueOnError="false"enabled="true"name="SetOAuthV2Info-1"><DisplayName>SetOAuthv2.0Info1</DisplayName><AccessTokenref={some-variable}></AccessToken><Attributes/></SetOAuthV2Info></xml>

<SetOAuthV2Info> attributes

<SetOAuthV2Info async="false" continueOnError="false" enabled="true" name="Set-OAuth-v20-Info-1">

The following table describes attributes that are common to all policy parent elements:

AttributeDescriptionDefaultPresence
name

The internal name of the policy. The value of thename attribute can contain letters, numbers, spaces, hyphens, underscores, and periods. This value cannot exceed 255 characters.

Optionally, use the<DisplayName> element to label the policy in the management UI proxy editor with a different, natural-language name.

N/ARequired
continueOnError

Set tofalse to return an error when a policy fails. This is expected behavior for most policies.

Set totrue to have flow execution continue even after a policy fails. See also:

falseOptional
enabled

Set totrue to enforce the policy.

Set tofalse toturn off the policy. The policy will not be enforced even if it remains attached to a flow.

trueOptional
async

This attribute is deprecated.

falseDeprecated

<DisplayName> element

Use in addition to thename attribute to label the policy in the management UI proxy editor with a different, natural-language name.

<DisplayName>Policy Display Name</DisplayName>
Default

N/A

If you omit this element, the value of the policy'sname attribute is used.

PresenceOptional
TypeString

<AccessToken> element

Identifies the variable where the access token is located. For example, if the access token is attached to request message as a query parameter, specifyrequest.queryparam.access_token. You can use any valid variable that references the token. Or, could pass in the literal token string (rare case).

 <AccessToken ref="request.queryparam.access_token"></AccessToken>
Default:N/A
Presence:Required
Type:String

Attributes

AttributeDescriptionDefaultPresence
ref

An access token variable. Typically, retrieved from a flow variable.

N/AOptional

<Attributes> element

A set of attributes in the access token profile that will be modified or augmented.

Default:N/A
Presence:Required
Type:N/A

<Attributes>/<Attribute> element

An individual attribute to update.

The name attribute identifies the custom property of the access token profile to be updated. This example shows how to use a referenced variable value and a static value.

  <Attributes>    <Attribute name="department.id" ref="request.queryparam.department_id"></Attribute>    <Attribute name="foo">bar</Attribute>  </Attributes>
Default:N/A
Presence:Optional
Type:N/A

Attributes

AttributeDescriptionDefaultPresence
nameThe name of the profile attribute to add or change.N/A
ref

The value to assign to the profile attribute.

N/AOptional

Flow variables

On success, the following flow variables will be set:

  • oauthv2accesstoken.{policyName}.access_token
  • oauthv2accesstoken.{policyName}.client_id
  • oauthv2accesstoken.{policyName}.refresh_count
  • oauthv2accesstoken.{policyName}.organization_name
  • oauthv2accesstoken.{policyName}.expires_in //--in seconds
  • oauthv2accesstoken.{policyName}.refresh_token_expires_in //--in seconds
  • oauthv2accesstoken.{policyName}.issued_at
  • oauthv2accesstoken.{policyName}.status
  • oauthv2accesstoken.{policyName}.api_product_list
  • oauthv2accesstoken.{policyName}.token_type
  • oauthv2accesstoken.{policyName}.{custom_attribute_name}

Schema

Each policy type is defined by an XML schema (.xsd). For reference,policy schemas are available on GitHub.

Error reference

This section describes the fault codes and error messages that are returned and fault variables that are set by Apigee when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, seeWhat you need to know about policy errors andHandling faults.

Runtime errors

These errors can occur when the policy executes.

Fault codeHTTP statusCause
steps.oauth.v2.access_token_expired500The access token sent to the policy is expired.
steps.oauth.v2.invalid_access_token500The access token sent to the policy is invalid.
steps.oauth.v2.InvalidAPICallAsNoApiProductMatchFound401Please see Oauth2.0 Access Token Verification throws "Invalid API call as no apiproduct match found" error for information about troubleshooting this error.

Deployment errors

Refer to the message reported in the UI for information about deployment errors.

Fault variables

These variables are set when this policy triggers an error at runtime.

Note: You an use these variables to create Fault Rule conditions. For more information, seeWhat you need to know about policy errors.
VariablesWhereExample
fault.name="fault_name"fault_name is the name of the fault, as listed in theRuntime errors table above. The fault name is the last part of the fault code.fault.name = "invalid_access_token"
oauthV2.policy_name.failedpolicy_name is the user-specified name of the policy that threw the fault.oauthV2.SetTokenInfo.failed = true
oauthV2.policy_name.fault.namepolicy_name is the user-specified name of the policy that threw the fault.oauthV2.SetTokenInfo.fault.name = invalid_access_token
oauthv2.policy_name.fault.causepolicy_name is the user-specified name of the policy that threw the fault.oauthV2.SetTokenInfo.cause = Invalid Access Token

Example error response

{  "fault": {    "faultstring": "Invalid Access Token",    "detail": {      "errorcode": "keymanagement.service.invalid_access_token"    }  }}

Example fault rule

<FaultRule name=SetOAuthV2Info Faults">    <Step>        <Name>AM-InvalidTokenResponse</Name>        <Condition>(fault.name = "invalid_access_token")</Condition>    </Step>    <Condition>(oauthV2.failed = true) </Condition></FaultRule>

Related topics

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-12-17 UTC.