You're viewing **Apigee Edge** documentation. [Go to the **Apigee X** documentation](http://cloud.google.com/apigee/docs/api-platform/reference/policies/get-oauth-v2-info-policy). info ![](https://docs.apigee.com/static/api-platform/images/icon_policy_security.jpg) ### What Gets attributes of access tokens, refresh tokens, authorization codes, and client app attributes and populates variables with the values of those attributes. This policy is useful when you need to configure dynamic, conditional behavior based on a value in a token or auth code. Whenever token validation occurs, variables are automatically populated with the values of token attributes. However, in cases where token validation has not occurred, you can use this feature to explicitly populate variables with the attribute values of a token. See also [Customizing Tokens and Authorization Codes](https://docs.apigee.com/api-platform/security/oauth/customizing-access-tokens). An access token that you pass to this policy must be valid or the policy will throw an `invalid_access_token` error. ### Note: The resource path that is used to call a proxy with this policy must be included in the Product that was used to generate the original token. In other words, if you call the proxy with the path `/tokeninfo`, then the `/tokeninfo` resource path must be included in the Product that was used to generate the token. If not, you will receive an `InvalidAPICallAsNoApiProductMatchFound` error. For more information, see [GetOAuthV2Info fails if token generated using product with resource paths](https://discuss.google.dev/t/getoauthv2info-fails-if-token-generated-using-product-with-resource-paths/14695) in the [Apigee Community](https://discuss.google.dev/c/google-cloud/cloud-apigee/104). ## Samples The following samples use the Get OAuth V2 Info policy to retrieve information about various components of the OAuth2 workflow and then then access that information within code. ### Access token To get a reference to an access token, use the `` element in your policy. The following example expects to find the access token in a query parameter named "access_token" (the actual implementation details are up to you): ``` ``` Given the access token, the policy looks up the token's profile and populates a set of variables with the profile data. You can then access the variables using JavaScript or another means. The following example retrieves the scope(s) associated with the access token using JavaScript: ``` var scope = context.getVariable('oauthv2accesstoken.MyTokenAttrsPolicy.scope'); ``` Note that to access those variables in code, you must prefix them with "oauthv2accesstoken". For a complete list of variables available via the access token, see [Access token variables](https://docs.apigee.com/api-platform/reference/policies/get-oauth-v2-info-policy#flowvariables-accesstokenvariables). ### Auth code To get authorization code attributes, use the `` element in your policy. The following example expects to find the access token in a form parameter named "code" (the actual implementation details are up to you): ``` ``` Given the auth code, the policy looks up the code's information and populates a set of variables with the auth code data. You can then access the variables using JavaScript or another means. The following example retrieves a custom attribute associated with the authorization code using JavaScript: ``` var attr = context.getVariable('oauthv2authcode.MyAuthCodeAttrsPolicy.custom_attribute_name'); ``` Note that to access those variables in code, you must prefix them with "oauthv2authcode". For a complete list of variables available via the auth code, see [Authorization code variables](https://docs.apigee.com/api-platform/reference/policies/get-oauth-v2-info-policy#flowvariables-authorizationcodevariables). ### Refresh token To get refresh token attributes, use the `` element in your policy. The following example expects to find the access token in a query parameter named "refresh_token" (the actual implementation details are up to you): ``` ``` Given the refresh token, the policy looks up the refresh token's information and populates a set of variables with the refresh token data. You can then access those variables using JavaScript or another means. The following example retrieves a custom attribute associated with the refresh token using JavaScript: ``` var attr = context.getVariable('oauthv2refreshtoken.MyRefreshTokenAttrsPolicy.accesstoken.custom_attribute_name'); ``` Note that to access the variables in code, you must prefix them with "oauthv2refreshtoken". For a complete list of variables available via the refresh token, see [Refresh token variables](https://docs.apigee.com/api-platform/reference/policies/get-oauth-v2-info-policy#flowvariables-refreshtokenvariables). ### Static In some rare cases you may need to get the profile of a statically configured token (one that is not accessible through a variable). You can do this by providing the value of the access token as an element. ``` shTUmeI1geSKin0TODcGLXBNe9vp ``` You can do this with all other token types (client ID, authorization code, and refresh tokens) as well. ### Client ID This example shows how to retrieve information about the client app using the client ID. Upon execution, the policy populates a set of variables with client information. In this case, the policy expects to find the client ID in a query parameter called `client_id`. Given the client ID, the policy looks up the client's profile and populates a set of variables with the profile data. The variables will be prefixed with `oauthv2client. ` ``` ``` You can then access the variables using JavaScript or another means. For example, to get the developer app name and developer email associated with the client app using JavaScript: ``` context.getVariable("oauthv2client.GetClientAttributes.developer.email"); context.getVariable("oauthv2client.GetClientAttributes.developer.app.name"); ``` *** ** * ** *** ## Element Reference The element reference describes the elements and attributes of the GetOAuthV2Info policy. ``` Get OAuth v2.0 Info 1 ``` ## \ attributes ``` ``` The following table describes attributes that are common to all policy parent elements: | Attribute | Description | Default | Presence | |---|---|---|---| | `name` | The internal name of the policy. The value of the `name` attribute can contain letters, numbers, spaces, hyphens, underscores, and periods. This value cannot exceed 255 characters. Optionally, use the `` element to label the policy in the management UI proxy editor with a different, natural-language name. | N/A | Required | | `continueOnError` | Set to `false` to return an error when a policy fails. This is expected behavior for most policies. Set to `true` to have flow execution continue even after a policy fails. | false | Optional | | `enabled` | Set to `true` to enforce the policy. Set to `false` to *turn off* the policy. The policy will not be enforced even if it remains attached to a flow. | true | Optional | | `async` | This attribute is deprecated. | false | Deprecated | ## \ element Use in addition to the `name` attribute to label the policy in the management UI proxy editor with a different, natural-language name. ``` Policy Display Name ``` | Default | N/A If you omit this element, the value of the policy's `name` attribute is used. | | Presence | Optional | | Type | String | |---|---| ## \ element Retrieves the profile for an access token. You pass in a either a variable that contains the access token string or a literal token string (rare case). In this example, the access token is retrieved from a query parameter passed in a request. Use the \ element if you want to return information for a revoked or expired token. ``` ``` |---|---| | **Default:** | request.formparam.access_token (a x-www-form-urlencoded and specified in the request body) | | **Presence:** | Optional | | **Type:** | String | | **Valid values:** | Either a flow variable containing an access token string, or a literal string. |
## \ element Retrieves the profile for an authorization code. You pass in a either a variable that contains the auth code string or a literal token string (rare case). In this example, the auth code is retrieved from a query parameter passed in a request. For a list of variables populated by this operation, see "[Flow variables](https://docs.apigee.com/api-platform/reference/policies/get-oauth-v2-info-policy#flowvariables)". ``` ``` |---|---| | **Default:** | request.formparam.access_token (a x-www-form-urlencoded and specified in the request body) | | **Presence:** | Optional | | **Type:** | String | | **Valid values:** | Either a flow variable containing an auth code string, or a literal string. | ## \ element Retrieves information related to a client ID. In this example, the client ID is retrieved from a query parameter passed in a request. For a list of variables populated by this operation, see "[Flow variables](https://docs.apigee.com/api-platform/reference/policies/get-oauth-v2-info-policy#flowvariables)". ``` ``` |---|---| | **Default:** | request.formparam.access_token (a x-www-form-urlencoded and specified in the request body) | | **Presence:** | Optional | | **Type:** | String | | **Valid values:** | Either a flow variable containing an auth code string, or a literal string. | ## \ element Returns the token information even if the token is expired or revoked. This element can only be used with access tokens. Information for other entities like refresh tokens and authorization codes are returned regardless of their status, by default. ``` true ``` |---|---| | **Default:** | false | | **Presence:** | Optional | | **Type:** | Boolean | | **Valid values:** | true or false | ## \ element Retrieves the profile for a refresh token. You pass in a either a variable that contains the refresh token string or a literal token string (rare case). In this example, the refresh token is retrieved from a query parameter passed in a request. For a list of variables populated by this operation, see "[Flow variables](https://docs.apigee.com/api-platform/reference/policies/get-oauth-v2-info-policy#flowvariables)". ``` ``` |---|---| | **Default:** | request.formparam.access_token (a x-www-form-urlencoded and specified in the request body) | | **Presence:** | Optional | | **Type:** | String | | **Valid values:** | Either a flow variable containing an refresh token string, or a literal string. | ## Flow variables The GetOAuthV2Info policy populates these variables, and is typically used in cases where you need the profile data, but where a grant or validation has not occurred yet. . ### Client ID variables These variables are populated when the ClientId element is set: ``` oauthv2client.{policy_name}.client_id oauthv2client.{policy_name}.client_secret oauthv2client.{policy_name}.redirection_uris // Note the spelling -- 'redirection_uris' oauthv2client.{policy_name}.developer.email oauthv2client.{policy_name}.developer.app.name oauthv2client.{policy_name}.developer.id oauthv2client.{policy_name}.{developer_app_custom_attribute_name} ``` ### Access token variables These variables are populated when the AccessToken element is set: ``` oauthv2accesstoken.{policy_name}.developer.id oauthv2accesstoken.{policy_name}.developer.app.name oauthv2accesstoken.{policy_name}.developer.app.id oauthv2accesstoken.{policy_name}.developer.email oauthv2accesstoken.{policy_name}.organization_name oauthv2accesstoken.{policy_name}.api_product_list oauthv2accesstoken.{policy_name}.access_token oauthv2accesstoken.{policy_name}.scope oauthv2accesstoken.{policy_name}.expires_in //in seconds oauthv2accesstoken.{policy_name}.status oauthv2accesstoken.{policy_name}.client_id oauthv2accesstoken.{policy_name}.accesstoken.{custom_attribute_name} oauthv2accesstoken.{policy_name}.refresh_token oauthv2accesstoken.{policy_name}.refresh_token_status oauthv2accesstoken.{policy_name}.refresh_token_expires_in //in seconds oauthv2accesstoken.{policy_name}.refresh_count oauthv2accesstoken.{policy_name}.refresh_token_issued_at oauthv2accesstoken.{policy_name}.revoke_reason //Apigee hybrid only with value of REVOKED_BY_APP, REVOKED_BY_ENDUSER, REVOKED_BY_APP_ENDUSER, or TOKEN_REVOKED ``` ### Authorization code variables These variables are populated when the AuthorizationCode element is set: ``` oauthv2authcode.{policy_name}.code oauthv2authcode.{policy_name}.scope oauthv2authcode.{policy_name}.redirect_uri oauthv2authcode.{policy_name}.client_id oauthv2authcode.{policy_name}.{auth_code_custom_attribute_name} ``` ### Refresh token variables These variables are populated when the RefreshToken element is set: ``` oauthv2refreshtoken.{policy_name}.developer.id oauthv2refreshtoken.{policy_name}.developer.app.name oauthv2refreshtoken.{policy_name}.developer.app.id oauthv2refreshtoken.{policy_name}.developer.email oauthv2refreshtoken.{policy_name}.organization_name oauthv2refreshtoken.{policy_name}.api_product_list oauthv2refreshtoken.{policy_name}.access_token oauthv2refreshtoken.{policy_name}.scope oauthv2refreshtoken.{policy_name}.expires_in //in seconds oauthv2refreshtoken.{policy_name}.status oauthv2refreshtoken.{policy_name}.client_id oauthv2refreshtoken.{policy_name}.accesstoken.{custom_attribute_name} oauthv2refreshtoken.{policy_name}.refresh_token oauthv2refreshtoken.{policy_name}.refresh_token_status oauthv2refreshtoken.{policy_name}.refresh_token_expires_in //in seconds oauthv2refreshtoken.{policy_name}.refresh_count oauthv2refreshtoken.{policy_name}.refresh_token_issued_at oauthv2refreshtoken.{policy_name}.revoke_reason //Apigee hybrid only with value of REVOKED_BY_APP, REVOKED_BY_ENDUSER, REVOKED_BY_APP_ENDUSER, or TOKEN_REVOKED ``` ## Schema Each policy type is defined by an XML schema (`.xsd`). For reference, [policy schemas](https://github.com/apigee/api-platform-samples/tree/master/schemas/policy) 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 Edge when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see [What you need to know about policy errors](https://docs.apigee.com/api-platform/fundamentals/what-you-need-know-about-policy-errors) and [Handling faults](https://docs.apigee.com/api-platform/fundamentals/fault-handling). ### Runtime errors These errors can occur when the policy executes. The error names shown below are the strings that are assigned to the `fault.name` variable when an error occurs. See the Fault variables section below for more details. | Fault code | HTTP status | Cause | |---|---|---| | `steps.oauth.v2.access_token_expired` | 500 | The access token sent to the policy is expired. | | `steps.oauth.v2.authorization_code_expired` | 500 | The authorization code sent to the policy is expired. | | `steps.oauth.v2.invalid_access_token` | 500 | The access token sent to the policy is invalid. | | `steps.oauth.v2.invalid_client-invalid_client_id` | 500 | The client ID sent to the policy is invalid. | | `steps.oauth.v2.invalid_refresh_token` | 500 | The refresh token sent to the policy is invalid. | | `steps.oauth.v2.invalid_request-authorization_code_invalid` | 500 | The authorization code sent to the policy is invalid. | | `steps.oauth.v2.InvalidAPICallAsNoApiProductMatchFound` | 401 | Please see [this Apigee Community post](https://discuss.google.dev/t/oauth2-0-access-token-verification-throws-invalid-api-call-as-no-apiproduct-match-found-error/17064) for information about troubleshooting this error. | | `steps.oauth.v2.refresh_token_expired` | 500 | The refresh token sent to the policy is expired. | ### 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] > **Note:** You an use these variables to create Fault Rule conditions. For more information, see [What you need to know > about policy errors](https://docs.apigee.com/api-platform/fundamentals/what-you-need-know-about-policy-errors). | Variables | Where | Example | |---|---|---| | `fault.name="fault_name"` | fault_name is the name of the fault, as listed in the [Runtime errors](https://docs.apigee.com/api-platform/reference/policies/get-oauth-v2-info-policy#runtime-errors) table above. The fault name is the last part of the fault code. | `fault.name Matches "IPDeniedAccess"` | | `oauthV2.policy_name.failed` | policy_name is the user-specified name of the policy that threw the fault. | `oauthV2.GetTokenInfo.failed = true` | | `oauthV2.policy_name.fault.name` | policy_name is the user-specified name of the policy that threw the fault. | `oauthV2.GetToKenInfo.fault.name = invalid_client-invalid_client_id` | | `oauthV2.policy_name.fault.cause` | policy_name is the user-specified name of the policy that threw the fault. | `oauthV2.GetTokenInfo.cause = ClientID is Invalid` | ### Example error response ``` { "fault":{ "faultstring":"ClientId is Invalid", "detail":{ "errorcode":"keymanagement.service.invalid_client-invalid_client_id" } } } ``` ### Example fault rule ``` AM-InvalidClientIdResponse (fault.name = "invalid_client-invalid_client_id") ```
## Related topics - [OAuthV2 policy](https://docs.apigee.com/api-platform/reference/policies/oauthv2-policy) - [OAuth home](https://docs.apigee.com/api-platform/security/oauth/oauth-home) - [Customizing Tokens and Authorization Codes](https://docs.apigee.com/api-platform/security/oauth/customizing-access-tokens)