SetOAuthV2Info 정책

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

내용

이를 사용하면 액세스 토큰과 연결된 커스텀 속성을 추가하거나 업데이트할 수 있습니다. 커스텀 속성에는 부서 이름, 고객 ID, 세션 식별자 등이 포함될 수 있습니다. 토큰 및 승인 코드 맞춤설정도 참조하세요.

커스텀 속성만 추가하거나 수정할 수 있습니다. 이 정책을 사용하여 scope, status, expires_in, developer_email, client_id, org_name, refresh_count 등의 필드를 변경할 수 없습니다. 속성이 이미 존재하는 경우 이 정책이 속성을 업데이트합니다. 속성이 존재하지 않는 경우 정책이 속성을 추가합니다. 참조된 액세스 토큰은 유효하고 승인된 상태여야 합니다.

샘플

<SetOAuthV2Info name="SetOAuthV2Info"> 
  <AccessToken ref="request.queryparam.access_token"></AccessToken>
  <Attributes>
    <Attribute name="department.id" ref="request.queryparam.department_id"></Attribute>
  </Attributes>
</SetOAuthV2Info>

요소 참조

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

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

<SetOAuthV2Info> 속성

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

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

<DisplayName> 요소

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

<DisplayName>Policy Display Name</DisplayName>

<AccessToken> 요소

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

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

특성

<Attributes> 요소

수정 또는 보강될 액세스 토큰 프로필의 속성 집합입니다.

<Attributes>/<Attribute> 요소

업데이트할 개별 속성입니다.

name 속성은 업데이트될 액세스 토큰 프로필의 커스텀 속성을 식별합니다. 이 예시에서는 참조된 변수 값과 정적 값을 사용하는 방법을 보여줍니다.

  <Attributes>
    <Attribute name="department.id" ref="request.queryparam.department_id"></Attribute>
    <Attribute name="foo">bar</Attribute>
  </Attributes>

특성

흐름 변수

성공하면 다음 흐름 변수가 설정됩니다.

• 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}

스키마

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

오류 참조

이 섹션에서는 반환되는 오류 코드, 오류 메시지, 정책이 오류를 트리거할 때 Edge에서 설정하는 오류 변수를 설명합니다. 오류를 처리하기 위해 오류 규칙을 개발 중인 경우, 이 정보는 중요합니다. 자세한 내용은 정책 오류에 대해 알아야 할 사항 및 오류 처리를 참조하세요.

런타임 오류

이러한 오류는 정책이 실행될 때 발생할 수 있습니다.

배포 오류

배포 오류에 대한 자세한 내용은 UI에 보고된 메시지를 참조하세요.

오류 변수

이러한 변수는 이 정책이 런타임 시 오류를 트리거할 때 설정됩니다.

오류 응답 예시

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

오류 규칙 예시

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

관련 주제

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