Bạn đang xem tài liệu về Apigee Edge.
Chuyển đến tài liệu về
Apigee X. thông tin
Giới thiệu | Mẫu | Tài liệu tham khảo
phần tử | Kết quả | Giản đồ | Chủ đề có liên quan
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ụ dưới đây tìm 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>
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ụ dưới đây 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 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 |
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:
|
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ụ: |
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).
<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ụ: |
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 |
Đầu ra
Khi thành công, chính sách này sẽ trả về trạng thái 200.
Nếu không thành công, chính sách sẽ trả về 404 và kết quả tương tự như sau (tuỳ thuộc vào việc bạn xoá mã truy cập hay mã xác thực):
HTTP/1.1 404 Not Found
Content-Type: application/json
Content-Length: 144
Connection: keep-alive
{"fault":{"faultstring":"Invalid Authorization Code","detail":{"errorcode":"keymanagement.service.invalid_request-authorization_code_invalid"}}}
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.