oauth_grant_management.rdoc

doc/oauth_grant_management.rdoc
Last Update: 2024-11-29 16:14:00 +0000

Documentation for OAuth Token Management feature

The oauth_grant_management feature provides OAuth Token Management interfaces, so users are able to view and revoke their oauth grants.

This feature depends on the oauth_base feature.

Auth Value Methods

oauth_grants_route

the route for accessing oauth grants, defaults to oauth-grants.

oauth_grants_path

returns URL path for oauth grants.

oauth_grants_id_pattern

pattern matcher to retrieve the oauth grant ID from the URL, Integer by default (must respond to “match”).

oauth_grants_page_title

Title for the client OAuth grants page.

oauth_grants_view

The HTML of the Oauth grants dashboard for the logged in account.

oauth_grants_per_page

max number of oauth grants to list in the routes listing oauth grants.

oauth_grants_expires_in_label

Label for the oauth grant expires in property.

oauth_grants_revoked_at_label

Label for the oauth grant revocation date.

oauth_grants_refresh_token_label

Label for the oauth grant refresh token.

oauth_grants_token_label

Label for the oauth grant.

oauth_grants_type_label

Label for the oauth grant type.

oauth_grant_revoke_button

Label for the grant revoke button.

oauth_no_grants_text

Lead text when grants list is empty.

Auth Methods

oauth_grant_path

returns URL path for an oauth grant.