GetOAuthV2Info 정책

<ph type="x-smartling-placeholder"></ph> 현재 Apigee Edge 문서를 보고 있습니다.
Apigee X 문서. 정보

대상

액세스 토큰, 갱신 토큰, 승인 코드, 클라이언트 앱 속성을 가져오고 변수를 이러한 속성의 값으로 채웁니다.

이 정책은 토큰 또는 인증 코드의 값에 따라 동적 조건부 동작을 구성해야 하는 경우에 유용합니다. 토큰 유효성 검사가 수행될 때마다 변수에 토큰 속성 값이 자동으로 입력됩니다. 그러나 토큰 유효성 검사가 수행되지 않은 경우 이 기능을 사용하여 토큰의 속성 값으로 변수를 명시적으로 채울 수 있습니다. 토큰 및 승인 코드 맞춤설정도 참조하세요.

이 정책에 전달하는 액세스 토큰이 유효해야 하며 그렇지 않으면 정책에서 invalid_access_token 오류가 발생합니다.

샘플

다음 샘플은 Get OAuth V2 Info 정책을 사용하여 OAuth2 워크플로의 다양한 구성요소에 대한 정보를 검색한 다음 코드 내에서 해당 정보에 액세스합니다.

<GetOAuthV2Info name="MyTokenAttrsPolicy">
  <AccessToken ref="request.queryparam.access_token"></AccessToken>
</GetOAuthV2Info>

var scope = context.getVariable('oauthv2accesstoken.MyTokenAttrsPolicy.scope');

<GetOAuthV2Info name="MyAuthCodeAttrsPolicy">
  <AuthorizationCode ref="request.formparam.code"></AuthorizationCode>
</GetOAuthV2Info>

var attr = context.getVariable(‘oauthv2authcode.MyAuthCodeAttrsPolicy.custom_attribute_name’);

<GetOAuthV2Info name="MyRefreshTokenAttrsPolicy">
  <RefreshToken ref="request.queryparam.refresh_token"/>
</GetOAuthV2Info>

var attr = context.getVariable(‘oauthv2refreshtoken.MyRefreshTokenAttrsPolicy.accesstoken.custom_attribute_name’);

<GetOAuthV2Info name="GetTokenAttributes">
  <AccessToken>shTUmeI1geSKin0TODcGLXBNe9vp</AccessToken>
</GetOAuthV2Info>

<GetOAuthV2Info name="GetClientAttributes">
  <ClientId ref="request.queryparam.client_id"></ClientId>
</GetOAuthV2Info>

context.getVariable("oauthv2client.GetClientAttributes.developer.email");
context.getVariable("oauthv2client.GetClientAttributes.developer.app.name");

요소 참조

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

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<GetOAuthV2Info async="false" continueOnError="false" enabled="true" name="GetOAuthV2Info-1"
    <DisplayName>Get OAuth v2.0 Info 1</DisplayName>
    <AccessToken ref="variable"></AccessToken>
    <AuthorizationCode ref="variable"></AuthorizationCode>
    <ClientId ref="variable"></ClientId>
    <RefreshToken ref="variable"></RefreshToken>
</GetOAuthV2Info>

<GetOAuthV2Info> 속성

<GetOAuthV2Info async="false" continueOnError="false" enabled="true" name="Get-OAuth-v20-Info-1">

다음 표는 모든 정책 상위 요소의 공통 속성에 대해 설명합니다.

<DisplayName> 요소

name 속성 외에도 이 요소를 사용하여 관리 UI 프록시 편집기의 정책에 다른 자연어 이름으로 라벨을 지정합니다.

<DisplayName>Policy Display Name</DisplayName>

<AccessToken> 요소

액세스 토큰의 프로필을 검색합니다. 액세스 코드 문자열 또는 리터럴 토큰 문자열(드문 사례)이 포함된 변수 중 하나를 전달합니다. 이 예시에서는 요청에 전달된 쿼리 매개변수에서 액세스 토큰을 검색합니다. 취소되거나 만료된 토큰에 대한 정보를 반환하려면 <IgnoreAccessTokenStatus> 요소를 사용하세요.

<AccessToken ref="request.queryparam.access_token"></AccessToken>

<AuthorizationCode> 요소

승인 코드의 프로필을 검색합니다. 인증 코드 문자열 또는 리터럴 토큰 문자열(드문 사례)이 포함된 변수 중 하나를 전달합니다. 이 예시에서는 요청에 전달된 쿼리 매개변수에서 인증 코드를 가져옵니다. 이 작업으로 채워진 변수의 목록은 '흐름 변수'를 참조하세요.

<AuthorizationCode ref="request.queryparam.authorization_code"></AuthorizationCode>

<ClientId> 요소

클라이언트 ID와 관련된 정보를 검색합니다. 이 예시에서는 요청에 전달된 쿼리 매개변수에서 클라이언트 ID를 검색합니다. 이 작업으로 채워진 변수의 목록은 '흐름 변수'를 참조하세요.

<ClientId ref="request.queryparam.client_id"></ClientId>

<IgnoreAccessTokenStatus> 요소

토큰이 만료되거나 취소된 경우에도 토큰 정보를 반환합니다. 이 요소는 액세스 토큰에만 사용할 수 있습니다. 갱신 토큰과 승인 코드와 같은 다른 항목의 정보는 기본적으로 상태와 관계없이 반환됩니다.

<IgnoreAccessTokenStatus>true</IgnoreAccessTokenStatus>

<RefreshToken> 요소

갱신 토큰의 프로필을 검색합니다. 갱신 코드 문자열 또는 리터럴 토큰 문자열(드문 사례)이 포함된 변수 중 하나를 전달합니다. 이 예시에서는 요청에 전달된 쿼리 매개변수에서 갱신 토큰을 검색합니다. 이 작업으로 채워진 변수의 목록은 '흐름 변수'를 참조하세요.

<RefreshToken ref="request.queryparam.refresh_token"></RefreshToken>

흐름 변수

GetOAuthV2Info 정책은 이러한 변수를 채우며, 일반적으로 프로필 데이터가 필요하지만 부여 또는 유효성 검사가 아직 수행되지 않은 경우에는 사용됩니다. .

클라이언트 ID 변수

이러한 변수는 ClientId 요소가 설정되면 채워집니다.

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}

액세스 토큰 변수

이러한 변수는 AccessToken 요소가 설정되면 채워집니다.

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

승인 코드 변수

이러한 변수는 AuthorizationCode 요소가 설정되면 채워집니다.

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}

갱신 토큰 변수

이러한 변수는 RefreshToken 요소가 설정되면 채워집니다.

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

스키마

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

오류 참조

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 and Handling faults.

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.

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.

Example error response

{  
   "fault":{  
      "faultstring":"ClientId is Invalid",
      "detail":{  
         "errorcode":"keymanagement.service.invalid_client-invalid_client_id"
      }
   }
}

Example fault rule

<FaultRule name="OAuthV2 Faults">
    <Step>
        <Name>AM-InvalidClientIdResponse</Name>
    </Step>
    <Condition>(fault.name = "invalid_client-invalid_client_id")</Condition>
</FaultRule>

관련 주제

• OAuthV2 정책
• OAuth 홈
• 토큰 및 승인 코드 맞춤설정