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

Bạn đang xem tài liệu về Apigee Edge.
Chuyển đến tài liệu về 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 liên kết với mã truy cập. Thuộc tính tuỳ chỉnh có thể bao gồm các thông tin như tên phòng ban, mã khách hàng hoặc mã nhận dạng phiên. Hãy xem thêm bài viết 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, hết hạn_in, email_developer_email, client_id, org_name hoặc refresh_count. Nếu đã có một thuộc tính, chính sách này sẽ cập nhật thuộc tính đó. Nếu mã này không tồn tại thì chính sách sẽ thêm nội dung đó vào. 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 phần tử mô tả các phần tử và thuộc tính của chính sách Set OAuthV2.

<?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 <Set OAuthV2Info>

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

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

Phần tử <DisplayName>

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

<DisplayName>Policy Display Name</DisplayName>

Phần tử <AccessToken>

Xác định biến nơi đặt mã truy cập. Ví dụ: nếu mã truy cập được đính kèm để yêu cầu thông báo 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ể chuyển vào chuỗi mã thông báo bằng giá trị cố định (hiếm khi 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ử <Thuộc tính>/<Thuộc tính>

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

Thuộc tính tên xác định thuộc tính tuỳ chỉnh của hồ sơ mã truy cập cần cập nhật. Ví dụ này cho biết 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 luồng

Khi thành công, các biến luồng sau 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). Giản đồ chính sách có sẵn trên GitHub để bạn tham khảo.

Tham chiếu lỗi

Phần này mô tả các mã lỗi và thông báo lỗi được trả về, cũng như các biến lỗi do Edge đặt khi chính sách này kích hoạt lỗi. Thông tin này đóng vai trò quan trọng trong việc phát triển các quy tắc lỗi để xử lý lỗi. Để tìm hiểu thêm, hãy xem Những điều bạn cần biết về lỗi chính sách và Xử lý lỗi.

Lỗi thời gian chạy

Những lỗi này có thể xảy ra khi thực thi chính sách.

Lỗi triển khai

Hãy tham khảo thông báo được báo cáo trong giao diện người dùng để biết thông tin về lỗi triển khai.

Biến lỗi

Các biến này được đặt khi chính sách này kích hoạt lỗi trong thời gian chạy.

Ví dụ về phản hồi lỗi

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

Ví dụ về quy tắc lỗi

<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
• Nhà OAuth
• Mã thông báo tuỳ chỉnh và Mã uỷ quyền