Thiết lập chính sách OAuthV2Info

Bạn đang xem tài liệu về Apigee Edge.
Truy cập vào tài liệu Apigee X. thông tin

Nội dung

Cho phép bạn thêm hoặc cập nhật các thuộc tính tuỳ chỉnh được liên kết với mã truy cập. Thuộc tính tuỳ chỉnh có thể bao gồm những thông tin như tên bộ phận, mã khách hàng hoặc mã nhận dạng phiên. Xem thêm phần Tuỳ chỉnh mã thông báo và mã uỷ quyền.

Bạn chỉ có thể thêm hoặc sửa đổi các thuộc tính tuỳ chỉnh. Bạn không thể sử dụng chính sách này để thay đổi các trường như phạm vi, trạng thái, expires_in, developer_email, client_id, org_name hoặc refresh_count. Nếu một thuộc tính đã tồn tại, chính sách này sẽ cập nhật thuộc tính đó. Nếu không tồn tại, chính sách sẽ thêm thông tin đó. Mã truy cập được tham chiếu phải hợp lệ và ở trạng thái được phê duyệt.

Mẫu

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

Tham chiếu phần tử

Tài liệu tham khảo về phần tử mô tả các phần tử và thuộc tính của chính sách 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>

Thuộc tính <SetOAuthV2Info>

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

Bảng sau đây mô tả những thuộc tính chung cho tất cả phần tử mẹ của chính sách:

&lt;DisplayName&gt; phần tử

Hãy sử dụng cùng với thuộc tính name để gắn nhãn chính sách trong phần trình chỉnh sửa proxy giao diện người dùng quản lý có tên ngôn ngữ tự nhiên khác.

<DisplayName>Policy Display Name</DisplayName>

Phần tử <AccessToken>

Xác định biến chứa mã truy cập. Ví dụ: nếu mã truy cập được đính kèm vào thông báo yêu cầu dưới dạng tham số truy vấn, hãy chỉ định request.queryparam.access_token. Bạn có thể sử dụng bất kỳ biến hợp lệ nào tham chiếu đến mã thông báo. Hoặc có thể truyền vào chuỗi mã thông báo theo nghĩa đen (trường hợp hiếm gặp).

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

Thuộc tính

Phần tử <Attributes>

Một tập hợp các thuộc tính trong hồ sơ mã truy cập sẽ được sửa đổi hoặc tăng cường.

Phần tử <Attributes>/<Attribute>

Một thuộc tính riêng lẻ cần cập nhật.

Thuộc tính name xác định thuộc tính tuỳ chỉnh của hồ sơ mã truy cập cần được cập nhật. Ví dụ này cho thấy cách sử dụng giá trị biến được tham chiếu và giá trị tĩnh.

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

Thuộc tính

Biến dòng

Khi thành công, các biến luồng sau đây sẽ được đặt:

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

Lược đồ

Mỗi loại chính sách được xác định bằng một giản đồ XML (.xsd). Để tham khảo, bạn có thể xem giản đồ chính sách trên GitHub.

Tham chiếu lỗi

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.

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": "Invalid Access Token",
    "detail": {
      "errorcode": "keymanagement.service.invalid_access_token"
    }
  }
}

Example fault rule

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

Chủ đề có liên quan

• Chính sách OAuthV2
• Trang chủ OAuth
• Tuỳ chỉnh mã thông báo và mã uỷ quyền