Chính sách GetOAuthV2Info

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

Lấy các thuộc tính của mã truy cập, mã làm mới, mã uỷ quyền và thuộc tính ứng dụng khách, đồng thời điền các biến bằng giá trị của những thuộc tính đó.

Chính sách này hữu ích khi bạn cần định cấu hình hành vi có điều kiện, linh động dựa trên một giá trị trong mã thông báo hoặc mã uỷ quyền. Bất cứ khi nào quá trình xác thực mã thông báo diễn ra, các biến sẽ tự động được điền sẵn bằng các giá trị của thuộc tính mã thông báo. Tuy nhiên, trong trường hợp chưa xác thực mã thông báo, bạn có thể sử dụng tính năng này để điền rõ ràng các biến bằng giá trị thuộc tính của mã thông báo. Xem thêm phần Tuỳ chỉnh mã thông báo và mã uỷ quyền.

Mã truy cập mà bạn truyền đến chính sách này phải hợp lệ, nếu không chính sách sẽ gửi ra lỗi invalid_access_token.

Mẫu

Các mẫu sau đây sử dụng chính sách Lấy thông tin OAuth phiên bản 2 để truy xuất thông tin về nhiều thành phần của quy trình OAuth2, sau đó truy cập vào thông tin đó trong mã.

<GetOAuthV2Info name="MyTokenAttrsPolicy">
  <AccessToken ref="request.queryparam.access_token"></AccessToken>
</GetOAuthV2Info>

var scope = context.getVariable('oauthv2accesstoken.MyTokenAttrsPolicy.scope');

<GetOAuthV2Info name="MyAuthCodeAttrsPolicy">
  <AuthorizationCode ref="request.formparam.code"></AuthorizationCode>
</GetOAuthV2Info>

var attr = context.getVariable(‘oauthv2authcode.MyAuthCodeAttrsPolicy.custom_attribute_name’);

<GetOAuthV2Info name="MyRefreshTokenAttrsPolicy">
  <RefreshToken ref="request.queryparam.refresh_token"/>
</GetOAuthV2Info>

var attr = context.getVariable(‘oauthv2refreshtoken.MyRefreshTokenAttrsPolicy.accesstoken.custom_attribute_name’);

<GetOAuthV2Info name="GetTokenAttributes">
  <AccessToken>shTUmeI1geSKin0TODcGLXBNe9vp</AccessToken>
</GetOAuthV2Info>

<GetOAuthV2Info name="GetClientAttributes">
  <ClientId ref="request.queryparam.client_id"></ClientId>
</GetOAuthV2Info>

context.getVariable("oauthv2client.GetClientAttributes.developer.email");
context.getVariable("oauthv2client.GetClientAttributes.developer.app.name");

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 GetOAuthV2Info.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<GetOAuthV2Info async="false" continueOnError="false" enabled="true" name="GetOAuthV2Info-1"
    <DisplayName>Get OAuth v2.0 Info 1</DisplayName>
    <AccessToken ref="variable"></AccessToken>
    <AuthorizationCode ref="variable"></AuthorizationCode>
    <ClientId ref="variable"></ClientId>
    <RefreshToken ref="variable"></RefreshToken>
</GetOAuthV2Info>

Thuộc tính <GetOAuthV2Info>

<GetOAuthV2Info async="false" continueOnError="false" enabled="true" name="Get-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>

Truy xuất hồ sơ cho mã truy cập. Bạn truyền vào một biến chứa chuỗi mã thông báo truy cập hoặc một chuỗi mã thông báo theo nghĩa đen (trường hợp hiếm gặp). Trong ví dụ này, mã truy cập được truy xuất từ một tham số truy vấn được truyền trong một yêu cầu. Sử dụng phần tử <IgnoreAccessTokenStatus> nếu bạn muốn trả về thông tin cho mã thông báo đã bị thu hồi hoặc hết hạn.

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

Phần tử <AuthorizationCode>

Truy xuất hồ sơ cho một mã uỷ quyền. Bạn truyền vào một biến chứa chuỗi mã xác thực hoặc một chuỗi mã thông báo theo nghĩa đen (trường hợp hiếm gặp). Trong ví dụ này, mã uỷ quyền được truy xuất từ một tham số truy vấn được truyền trong một yêu cầu. Để xem danh sách các biến được điền sẵn bằng thao tác này, hãy xem phần "Biến luồng".

<AuthorizationCode ref="request.queryparam.authorization_code"></AuthorizationCode>

Phần tử <ClientId>

Truy xuất thông tin liên quan đến một mã khách hàng. Trong ví dụ này, mã ứng dụng khách được truy xuất từ một tham số truy vấn được truyền trong một yêu cầu. Để xem danh sách các biến được điền sẵn bằng thao tác này, hãy xem phần "Biến luồng".

<ClientId ref="request.queryparam.client_id"></ClientId>

Phần tử <IgnoreAccessTokenStatus>

Trả về thông tin mã thông báo ngay cả khi mã thông báo đã hết hạn hoặc bị thu hồi. Bạn chỉ có thể dùng phần tử này với mã truy cập. Thông tin cho các thực thể khác như mã làm mới và mã uỷ quyền sẽ được trả về bất kể trạng thái của chúng theo mặc định.

<IgnoreAccessTokenStatus>true</IgnoreAccessTokenStatus>

Phần tử <RefreshToken>

Truy xuất hồ sơ cho mã làm mới. Bạn truyền vào một biến chứa chuỗi mã làm mới hoặc một chuỗi mã cố định (trường hợp hiếm gặp). Trong ví dụ này, mã làm mới được truy xuất từ một tham số truy vấn được truyền trong một yêu cầu. Để xem danh sách các biến được điền sẵn bằng thao tác này, hãy xem phần "Biến luồng".

<RefreshToken ref="request.queryparam.refresh_token"></RefreshToken>

Biến của quy trình

Chính sách GetOAuthV2Info sẽ điền sẵn các biến này và thường được dùng trong trường hợp bạn cần dữ liệu hồ sơ, nhưng chưa có hoạt động cấp hoặc xác thực nào diễn ra. .

Biến mã ứng dụng khách

Các biến này được điền sẵn khi phần tử ClientId được đặt:

oauthv2client.{policy_name}.client_id
oauthv2client.{policy_name}.client_secret
oauthv2client.{policy_name}.redirection_uris // Note the spelling -- 'redirection_uris'
oauthv2client.{policy_name}.developer.email
oauthv2client.{policy_name}.developer.app.name
oauthv2client.{policy_name}.developer.id
oauthv2client.{policy_name}.{developer_app_custom_attribute_name}

Biến mã truy cập

Các biến này được điền sẵn khi phần tử AccessToken được đặt:

oauthv2accesstoken.{policy_name}.developer.id
oauthv2accesstoken.{policy_name}.developer.app.name
oauthv2accesstoken.{policy_name}.developer.app.id
oauthv2accesstoken.{policy_name}.developer.email

oauthv2accesstoken.{policy_name}.organization_name
oauthv2accesstoken.{policy_name}.api_product_list

oauthv2accesstoken.{policy_name}.access_token
oauthv2accesstoken.{policy_name}.scope
oauthv2accesstoken.{policy_name}.expires_in //in seconds
oauthv2accesstoken.{policy_name}.status
oauthv2accesstoken.{policy_name}.client_id
oauthv2accesstoken.{policy_name}.accesstoken.{custom_attribute_name}

oauthv2accesstoken.{policy_name}.refresh_token
oauthv2accesstoken.{policy_name}.refresh_token_status
oauthv2accesstoken.{policy_name}.refresh_token_expires_in //in seconds

oauthv2accesstoken.{policy_name}.refresh_count
oauthv2accesstoken.{policy_name}.refresh_token_issued_at
oauthv2accesstoken.{policy_name}.revoke_reason //Apigee hybrid only with value of REVOKED_BY_APP, REVOKED_BY_ENDUSER, REVOKED_BY_APP_ENDUSER, or TOKEN_REVOKED

Biến mã uỷ quyền

Các biến này được điền sẵn khi phần tử AuthorizationCode được đặt:

oauthv2authcode.{policy_name}.code
oauthv2authcode.{policy_name}.scope
oauthv2authcode.{policy_name}.redirect_uri
oauthv2authcode.{policy_name}.client_id
oauthv2authcode.{policy_name}.{auth_code_custom_attribute_name}

Làm mới các biến mã thông báo

Các biến này được điền khi phần tử RefreshToken được đặt:

oauthv2refreshtoken.{policy_name}.developer.id
oauthv2refreshtoken.{policy_name}.developer.app.name
oauthv2refreshtoken.{policy_name}.developer.app.id
oauthv2refreshtoken.{policy_name}.developer.email
oauthv2refreshtoken.{policy_name}.organization_name
oauthv2refreshtoken.{policy_name}.api_product_list

oauthv2refreshtoken.{policy_name}.access_token
oauthv2refreshtoken.{policy_name}.scope
oauthv2refreshtoken.{policy_name}.expires_in //in seconds

oauthv2refreshtoken.{policy_name}.status
oauthv2refreshtoken.{policy_name}.client_id
oauthv2refreshtoken.{policy_name}.accesstoken.{custom_attribute_name}

oauthv2refreshtoken.{policy_name}.refresh_token
oauthv2refreshtoken.{policy_name}.refresh_token_status
oauthv2refreshtoken.{policy_name}.refresh_token_expires_in //in seconds

oauthv2refreshtoken.{policy_name}.refresh_count
oauthv2refreshtoken.{policy_name}.refresh_token_issued_at
oauthv2refreshtoken.{policy_name}.revoke_reason //Apigee hybrid only with value of REVOKED_BY_APP, REVOKED_BY_ENDUSER, REVOKED_BY_APP_ENDUSER, or TOKEN_REVOKED

Lược đồ

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

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 rất quan trọng nếu bạn đang phát triển các quy tắc lỗi để xử lý lỗi. Để tìm hiểu thêm, hãy xem bài viết Những điều bạn cần biết về lỗi chính sách và Cách xử lý lỗi.

Lỗi thời gian chạy

Những lỗi này có thể xảy ra khi chính sách này thực thi. Tên lỗi được hiển thị bên dưới là các chuỗi được gán cho biến fault.name khi xảy ra lỗi. Xem lỗi về biến bên dưới để biết thêm thông tin chi tiết.

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ề các 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 khi gặp lỗi

{  
   "fault":{  
      "faultstring":"ClientId is Invalid",
      "detail":{  
         "errorcode":"keymanagement.service.invalid_client-invalid_client_id"
      }
   }
}

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

<FaultRule name="OAuthV2 Faults">
    <Step>
        <Name>AM-InvalidClientIdResponse</Name>
    </Step>
    <Condition>(fault.name = "invalid_client-invalid_client_id")</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