Xóa 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

Xoá mã uỷ quyền OAuth V2 hoặc mã truy cập được chỉ định.

Mẫu

Xoá mã thông báo truy cập

Dưới đây là ví dụ về chính sách dùng để xoá mã truy cập OAuth 2.0. Ví dụ bên dưới cho thấy mã truy cập cần xoá trong thông báo yêu cầu bằng cách tìm một tiêu đề có tên là access_token.

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

Xoá mã xác thực

Dưới đây là một ví dụ về chính sách dùng để xoá mã uỷ quyền OAuth 2.0. Ví dụ bên dưới tìm mã xác thực cần xoá trong thông điệp yêu cầu bằng cách tìm một tham số truy vấn có tên là code.

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

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 Delete OAuthV2Info.

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

Thuộc tính<Delete OAuthV2Info>

<DeleteOAuthV2Info async="false" continueOnError="false" enabled="true" name="Delete-OAuth-v20-Info-1">
Thuộc tính Nội dung mô tả Mặc định Sự hiện diện
async

Đặt thành true để chỉ định rằng chính sách sẽ chạy trong một nhóm luồng khác với nhóm thực hiện luồng yêu cầu/phản hồi. Mặc định là false.

Chế độ cài đặt này chỉ dùng để tối ưu hoá nội bộ.

false Không bắt buộc
continueOnError

Hầu hết các chính sách đều dự kiến sẽ trả về lỗi khi xảy ra lỗi. Khi bạn đặt thuộc tính này thành true, quá trình thực thi Flow không thành công sẽ tiếp tục.

false Không bắt buộc
đang bật Xác định xem một chính sách có được thực thi hay không. Nếu bạn đặt thành false, thì một chính sách sẽ "tắt" và không được thực thi (mặc dù chính sách này vẫn được đính kèm trong một Luồng). đúng Không bắt buộc
tên

Tên nội bộ của chính sách. Tên này được tham chiếu trong các phần tử Bước để đính kèm chính sách vào một Flow.

Lưu ý: Bạn chỉ có thể sử dụng các ký tự sau đây trong tên: A-Z0-9._\-$ %. Giao diện người dùng quản lý thực thi các hạn chế bổ sung, chẳng hạn như tự động xoá các ký tự không phải là chữ và số.

Không áp dụng Bắt buộc

Phần tử <AccessToken>

Xác định biến chứa mã truy cập cần xoá. 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 có tên là "access_token", 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>
Mặc định: Không áp dụng
Sự hiện diện: Bạn phải nhập <AccessToken> hoặc <AuthorizationCode>.
Loại: Chuỗi

Thuộc tính

Thuộc tính Nội dung mô tả Mặc định Sự hiện diện
giới thiệu

Biến mã truy cập. Thường được truy xuất từ biến luồng. Ví dụ: request.header.token hoặc request.queryparam.token.

Không áp dụng Không bắt buộc

Phần tử <Uỷ quyềnCode>

Xác định biến chứa mã uỷ quyền cần xoá. Ví dụ: nếu mã xác thực được đính kèm để yêu cầu thông báo dưới dạng tham số truy vấn có tên là "code", hãy chỉ định request.queryparam.code. 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).

 <AuthorizationCode ref="request.queryparam.code"></AuthorizationCode>
Mặc định: Không áp dụng
Sự hiện diện: Bạn phải nhập <AccessToken> hoặc <AuthorizationCode>.
Loại: Chuỗi

Thuộc tính

Thuộc tính Nội dung mô tả Mặc định Sự hiện diện
giới thiệu

Biến mã truy cập. Thường được truy xuất từ biến luồng. Ví dụ: request.header.code hoặc request.queryparam.code.

Không áp dụng Không bắt buộc

Phần tử<DisplayName>

Tên ngôn ngữ tự nhiên để gắn nhãn chính sách trong trình chỉnh sửa proxy giao diện người dùng quản lý. Nếu bạn bỏ qua thuộc tính tên chính sách, hệ thống sẽ sử dụng thuộc tính này.

<DisplayName>DeleteOAuthV2Info 1</DisplayName>
Mặc định: Giá trị của thuộc tính name của chính sách.
Sự hiện diện: Không bắt buộc
Loại: Chuỗi

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áchXử 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.

Mã lỗi Trạng thái HTTP Nguyên nhân
steps.oauth.v2.invalid_access_token 401 Mã truy cập mà bạn gửi cho chính sách này là không hợp lệ.
steps.oauth.v2.invalid_request-authorization_code_invalid 401 Mã uỷ quyền mà bạn gửi đến chính sách này là không hợp lệ.
steps.oauth.v2.InvalidAPICallAsNoApiProductMatchFound 401 Vui lòng xem bài đăng này trên Cộng đồng Apigee để biết thông tin về cách khắc phục lỗi này.

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.

Biến Trong đó Ví dụ:
fault.name="fault_name" fault_name là tên của lỗi, như liệt kê trong bảng Lỗi thời gian chạy ở trên. Tên lỗi là phần cuối cùng của mã lỗi. fault.name = "invalid_access_token"
oauthV2.policy_name.failed policy_name là tên của chính sách báo lỗi do người dùng chỉ định. oauthV2.DeleteTokenInfo.failed = true
oauthV2.policy_name.fault.name policy_name là tên của chính sách báo lỗi do người dùng chỉ định. oauthV2.DeleteTokenInfo.fault.name = invalid_access_token
oauthv2.policy_name.fault.cause policy_name là tên của chính sách báo lỗi do người dùng chỉ định. oauthV2.DeleteTokenInfo.cause = Invalid Access Token

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="VariableOfNonMsgType"></faultrule><FaultRule name="DeleteOAuthV2Info_Faults">
    <Step>
        <Name>AM-InvalidTokenResponse</Name>
    </Step>
    <Condition>(fault.name = "invalid_access_token")</Condition>
</FaultRule>

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.

Chủ đề có liên quan