Documentation for OAuth Authorization Base feature¶ ↑
The oauth_authorization_base
provides common functionality shared by OAuth grant implementations (oauth_authorization_code_grant, oauth_implicit_grant or oauth_device_code_grant, to name a few).
It implements the Authorization Request form page.
This feature depends on the oauth_base feature.
Auth Value Methods¶ ↑
oauth_authorize_button |
Label of Authorize form button. |
oauth_authorize_post_button |
Label of post-authorize form button. |
authorize_route |
the route for the authorize action, defaults to |
authorize_page_title |
Title of authorize form page. |
authorize_error_page_title |
Title of the authorize error page. |
oauth_grants_access_type_column |
the db column where the oauth grant access type is stored, <tt>:access_type<tt> by default. |
use_oauth_access_type? |
Whether the “access_type” parameter is supported, |
oauth_grants_scopes_label |
Label for the oauth grant scopes. |
authorize_page_lead |
lead text for the authorization form. |
oauth_applications_contacts_label |
Form label for the oauth application contacts. |
oauth_applications_policy_uri_label |
Form label for the oauth application Policy URI. |
oauth_applications_tos_uri_label |
Form label for the oauth application Terms of Service URI. |
oauth_unsupported_response_type_message |
Error message for the |
oauth_authorize_parameter_required |
Error message for required params missing from the authorization request. |
Auth Methods¶ ↑
oauth_grants_resource_owner_columns |
db columns which identify a resource owner in the grants table. |
resource_owner_params |
conditionals to filter grants by a given logged in resource owner. |
before_authorize_route |
Run arbitrary code before the authorize route. |
before_authorize |
Run arbitrary code before executing an “authorize” endpoint. |
after_authorize |
Run arbitrary code after authorizing a request. |
authorize_view |
The HTML of the Authorize form. |
authorize_error_view |
The HTML of the Authorize error page. |