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

Giới thiệu | Mẫu | Tài liệu tham khảo về phần tử | Đầu ra | Lược đồ | Các chủ đề có liên quan

Nội dung

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

Mẫu

Xoá mã 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 sẽ xác định vị trí mã truy cập cần xoá trong thông báo yêu cầu bằng cách tìm 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ụ bên dưới xác định mã uỷ quyền cần xoá trong thông báo 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 về phần tử mô tả các phần tử và thuộc tính của chính sách DeleteOAuthV2Info.

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

<DeleteOAuthV2Info async="false" continueOnError="false" enabled="true" name="Delete-OAuth-v20-Info-1">
Thuộc tính Mô tả Mặc định Tỷ lệ hiển thị
không đồng bộ

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

Chế độ cài đặt này chỉ được 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. Bằng cách đặt thuộc tính này thành true, quá trình thực thi Flow sẽ tiếp tục khi gặp lỗi.

 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 được đặt thành false, một chính sách sẽ "tắt" và không được thực thi (mặc dù chính sách vẫn được đính kèm vào một Luồng). true 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 Luồng.

Lưu ý: Bạn chỉ có thể sử dụng các ký tự sau trong tên: A-Z0-9._\-$ %. Giao diện người dùng quản lý áp dụng 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 vào thông báo yêu cầu dưới dạng một 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ể 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>
Mặc định: Không áp dụng
Trạng thái hiện diện: Bạn bắt buộc phải sử dụng <AccessToken> hoặc <AuthorizationCode>.
Loại: Chuỗi

Thuộc tính

Thuộc tính Mô tả Mặc định Tỷ lệ hiển thị
ref

Một biến mã truy cập. Thường được truy xuất từ mộ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ử <AuthorizationCode>

Xác định biến chứa mã uỷ quyền cần xoá. Ví dụ: nếu mã uỷ quyền được đính kèm vào thông báo yêu cầu dưới dạng một 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ể 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>
Mặc định: Không áp dụng
Trạng thái hiện diện: Bạn bắt buộc phải sử dụng <AccessToken> hoặc <AuthorizationCode>.
Loại: Chuỗi

Thuộc tính

Thuộc tính Mô tả Mặc định Tỷ lệ hiển thị
ref

Một biến mã truy cập. Thường được truy xuất từ mộ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 bằng ngôn ngữ tự nhiên dùng để 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 sẽ được sử dụng.

<DisplayName>DeleteOAuthV2Info 1</DisplayName>
Mặc định: Giá trị của thuộc tính name trong chính sách.
Trạng thái 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 sẽ trả về trạng thái 200.

Khi thất bại, chính sách sẽ trả về 404 và đầu ra tương tự như sau (tuỳ thuộc vào việc bạn đang xoá mã truy cập hay mã uỷ quyền):

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). Để tham khảo, bạn có thể xem giản đồ chính sách trên GitHub.

Chủ đề có liên quan