Send Docs Feedback

Note: Most user interface tasks can be performed in Edge Classic or the New Edge experience. For an overview, getting started topics, and release notes specific to the New Edge experience, see the docs.

Delete OAuth V1 Info policy

  

What

Deletes OAuth v1.0a request tokens, verifiers, and access tokens.

Where

This policy can be attached in the following locations. 

ProxyEndpoint TargetEndpoint
    PreFlow Flow PostFlow PreFlow Flow PostFlow    
Request    
    Response
    PostFlow Flow PreFlow PostFlow Flow PreFlow    

Samples

Below is an example policy used to delete an OAuth 1.0a access token. The example below locates the access token to delete on the request message by looking for a header called token.

<DeleteOAuthV1Info name="DeleteAccessToken">
     <AccessToken ref="request.header.token"></AccessToken>
</DeleteOAuthV1Info>

Below is an example policy used to delete an OAuth 1.0a verifier. The example below locates the verifier to delete on the request message by looking for a query parameter called verifier.

<DeleteOAuthV1Info name="DeleteAccessToken">
     <Verifier ref="request.queryparam.verifier"></Verifier>
</DeleteOAuthV1Info>

Element Reference

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

<DeleteOAuthV1Info async="false" continueOnError="false" enabled="true" name="Delete-OAuth-v10-Info-1">
    <DisplayName>Delete OAuth v1.0 Info-1</DisplayName>
    <Properties/>
    <AccessToken ref="request.header.token"/>
    <!--<RequestToken ref="request.header.token"></RequestToken>-->
    <!--<Verifier ref="request.header.verifier"></Verifier>-->
</DeleteOAuthV1Info>

<DeleteOAuthV1Info> attributes

<DeleteOAuthV1Info async="false" continueOnError="false" enabled="true" name="Delete-OAuth-v1-Info-1">
Attribute Description Default Presence
async

Set to true to specify that the policy should be run in a thread pool different than the pool servicing the request/response flow. Default is false.

This setting is only used for for internal optimization.

false Optional
continueOnError

Most policies are expected to return an error when a failure occurs. By setting this attribute to true, Flow execution continues on failure.

false Optional
enabled Determines whether a policy is enforced or not. If set to false, a policy is 'turned off', and not enforced (even though the policy remains attached to a Flow). true Optional
name

The internal name of the policy. This name is referenced in Step elements to attach the policy to a Flow.

Note: Characters you can use in the name are restricted to: A-Z0-9._\-$ %. The Management UI enforces additional restrictions, such as automatically removing characters that are not alphanumeric.

N/A Required

<AccessToken> element

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

 <AccessToken ref="request.header.token"></AccessToken>
Default: N/A
Presence: Required for access token deletion.
Type: String

Attributes

Attribute Description Default Presence
ref

An access token variable. Typically, retrieved from a flow variable. For example: request.header.token or request.queryparam.token.

N/A Optional

<DisplayName> element

A natural-language name that labels the policy in the management UI proxy editor. If omitted, the policy name attribute is used.

<DisplayName>DeleteOAuthV1Info 1</DisplayName>
Default: The value of the policy's name attribute.
Presence: Optional
Type: String

 

<RequestToken> element

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

 <RequestToken ref="request.header.token"></RequestToken>
Default: N/A
Presence: Required for request token deletion.
Type: String

Attributes

Attribute Description Default Presence
ref

A request token variable. Typically, retrieved from a flow variable. For example: request.header.token or request.queryparam.token.

N/A Optional

<Verifier> element

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

 <Verifier ref="request.header.verifier"></Verifier>
Default: N/A
Presence: Required for verifier deletion.
Type: String

Attributes

Attribute Description Default Presence
ref

A variable containing the verifier. Typically, retrieved from a flow variable. For example: request.header.verifier or request.queryparam.verifier.

N/A Optional

Error codes

On success, the policy returns a 200 status.

On failure, the policy returns 404 and output similar to the following (depending on whether you are deleting an access token, request token, or verifier.):

HTTP/1.1 404 Not Found
Content-Type: application/json
Content-Length: 144
Connection: keep-alive

{"fault":{"faultstring":"Invalid Access Token","detail":{"errorcode":"keymanagement.service.invalid_request-access_token_invalid"}}}


Schema

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

Related topics

Help or comments?