oauth_dynamic_client_registration.rdoc

doc/oauth_dynamic_client_registration.rdoc

The oauth_dynamic_client_registration feature adds support for the OAuth 2.0 dynamic client registration protocol.

This feature depends on the oauth_base feature.

Client metadata

Client metadata which the server does not understand, that is, which maps to neither an +oauth_applications_*_column+ auth value method nor a column of the applications table, is ignored, as mandated by datatracker.ietf.org/doc/html/rfc7591#section-3.1. It is left out of the registration, and out of the registration response as well.

Metadata which the server does understand but the client may not set, such as client_id or account_id, still fails the request with an "invalid_client_metadata" error, as does metadata with an unsupported value.

Auth Value Methods

oauth_client_registration_required_params

request params required to be present in the register body for it to succeed.

oauth_applications_registration_access_token_column

db column where an oauth application registration access token is stored, after being hashed.

registration_client_uri_route

the route where the client registration uri is available, and existing client applications can be further manipulated (via GET and PATCH verbs).

register_route

the route for registering dynamic clients, defaults to register.

Auth Methods

before_register

Run arbitrary code before registering a new client application.

before_register_route

Run arbitrary code before the register route.