DeleteOAuthV2Info

현재 Apigee Edge 문서가 표시되고 있습니다.
Apigee X 문서로 이동 정보

정보 | 샘플 | 요소 참조 | 출력 | 스키마 | 관련 주제

내용

지정된 OAuth V2 승인 코드 또는 액세스 토큰을 삭제합니다.

샘플

액세스 토큰 삭제

다음은 OAuth 2.0 액세스 토큰을 삭제하는 데 사용되는 정책 예시입니다. 아래 예시에서는 access_token 헤더를 찾아 요청 메시지에서 삭제할 액세스 토큰을 찾습니다.

<DeleteOAuthV2Info name="DeleteAccessToken">
     <AccessToken ref="request.header.access_token"></AccessToken>
</DeleteOAuthV2Info>

다음은 OAuth 2.0 승인 코드를 삭제하는 데 사용되는 정책 예시입니다. 아래 예시에서는 code라는 쿼리 매개변수를 찾아 요청 메시지에서 삭제할 인증 코드를 찾습니다.

<DeleteOAuthV2Info name="DeleteAuthCode">
     <AuthorizationCode ref="request.queryparam.code"></AuthorizationCode>
</DeleteOAuthV2Info>

요소 참조

요소 참조는 DeleteOAuthV2Info 정책의 요소 및 속성을 설명합니다.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<DeleteOAuthV2Info async="false" continueOnError="false" enabled="true" name="DeleteOAuthV2Info-1">    
    <DisplayName>Delete OAuth v2.0 Info 1</DisplayName>
    <AccessToken ref={some-variable}></AccessToken>
    <!--<AuthorizationCode ref={some-variable}></AuthorizationCode>-->
    <Attributes/>
</DeleteOAuthV2Info

<DeleteOAuthV2Info> 속성

<DeleteOAuthV2Info async="false" continueOnError="false" enabled="true" name="Delete-OAuth-v20-Info-1">
속성 설명 기본 계정 현재 상태
async

요청/응답 흐름을 제공하는 풀과 상이한 스레드 풀에서 정책을 실행해야 하는 것으로 지정하려면 true로 설정합니다. 기본값은 false입니다.

이 설정은 내부 최적화에만 사용됩니다.

 false 선택사항
continueOnError

대부분의 정책은 장애가 발생할 때 오류를 반환해야 합니다. 이 속성을 true로 설정하면 장애 시 흐름 실행이 계속됩니다.

 false 선택사항
사용 설정됨 정책의 시행 여부를 결정합니다. false로 설정되면 정책이 '사용 중지'되어 시행되지 않습니다(정책이 흐름에 연결된 상태로 유지되더라도 마찬가지). true 선택사항
이름

정책의 내부 이름입니다. 이 이름은 정책을 흐름에 연결하기 위해 단계 요소에서 참조됩니다.

참고: 이름에 사용할 수 있는 문자는 A-Z0-9._\-$ %로 제한됩니다. 관리 UI는 영숫자가 아닌 문자를 자동으로 삭제하는 등의 추가 제한사항을 적용합니다.

 N/A 필수

<AccessToken> 요소

삭제할 액세스 토큰이 위치한 변수를 식별합니다. 예를 들어 액세스 토큰이 'access_token'이라는 쿼리 매개변수로 요청 메시지에 연결된 경우 request.queryparam.access_token을 지정합니다. 토큰을 참조하는 모든 유효한 변수를 사용할 수 있습니다. 또는 리터럴 토큰 문자열(드문 사례)을 전달할 수도 있습니다.

 <AccessToken ref="request.queryparam.access_token"></AccessToken>
기본값: N/A
현재 상태: <AccessToken> 또는 <AuthorizationCode>가 필요합니다.
유형: 문자열

특성

속성 설명 기본 계정 현재 상태
ref

액세스 토큰 변수입니다. 일반적으로 흐름 변수에서 가져옵니다. 예를 들면 request.header.token 또는 request.queryparam.token입니다.

 N/A 선택사항

<AuthorizationCode> 요소

삭제할 승인 코드가 위치한 변수를 식별합니다. 예를 들어 인증 코드가 'code'라는 쿼리 매개변수로 요청 메시지에 연결된 경우 request.queryparam.code를 지정합니다. 토큰을 참조하는 모든 유효한 변수를 사용할 수 있습니다. 또는 리터럴 토큰 문자열(드문 사례)을 전달할 수도 있습니다.

 <AccessToken ref="request.queryparam.access_token"></AccessToken>
기본값: N/A
현재 상태: <AccessToken> 또는 <AuthorizationCode>가 필요합니다.
유형: 문자열

특성

속성 설명 기본 계정 현재 상태
ref

액세스 토큰 변수입니다. 일반적으로 흐름 변수에서 가져옵니다. 예를 들면 request.header.code 또는 request.queryparam.code입니다.

 N/A 선택사항

<DisplayName> 요소

관리 UI 프록시 편집기에서 정책에 라벨을 지정하는 자연어 이름입니다. 생략하면 정책 이름 속성이 사용됩니다.

<DisplayName>DeleteOAuthV2Info 1</DisplayName>
기본값: 정책의 name 속성 값입니다.
현재 상태: 선택사항
유형: 문자열

출력

성공하면 정책이 200 상태를 반환합니다.

실패하면 정책은 404와 다음과 비슷한 출력을 반환합니다(액세스 토큰 또는 인증 코드 삭제 여부에 따라 다름).

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

{"fault":{"faultstring":"Invalid Authorization Code","detail":{"errorcode":"keymanagement.service.invalid_request-authorization_code_invalid"}}}

스키마

각 정책 유형은 XML 스키마(.xsd)로 정의됩니다. 참고로 GitHub에서 정책 스키마를 사용할 수 있습니다.

관련 주제