Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: dynamic client registration path in hydra docs #854

Merged
merged 1 commit into from
Jun 8, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -24,17 +24,17 @@ oidc:

Enabling this feature will add listeners to the following four routes at the public endpoint:

- `POST /openid/register` - Register a new OAuth2 Client;
- `GET /openid/register/<client_id>` - Fetch the OAuth2 Client;
- `PUT /openid/register/<client_id>` - Update the OAuth2 Client;
- `DELETE /openid/register/<client_id>` - Delete the OAuth2 Client;
- `POST /oauth2/register` - Register a new OAuth2 Client;
- `GET /oauth2/register/<client_id>` - Fetch the OAuth2 Client;
- `PUT /oauth2/register/<client_id>` - Update the OAuth2 Client;
- `DELETE /oauth2/register/<client_id>` - Delete the OAuth2 Client;

## Register OAuth2 & OpenID Connect Clients

If OpenID Connect Dynamic Client Registration is enabled, registering a new OAuth2 Client is as simple as:

```
POST /openid/register
POST /oauth2/register
Content-Type: application/json

{
Expand Down Expand Up @@ -63,7 +63,7 @@ The `POST` endpoint requires the client to authenticate with the `registration_a
`token_endpoint_auth_method`. It can be used to update the OAuth2 Client.

```
PUT /openid/register/{client_id}
PUT /oauth2/register/{client_id}
Authorization: Bearer <registration_access_token>
Content-Type: application/json

Expand Down Expand Up @@ -95,7 +95,7 @@ The `GET` endpoint requires the client to authenticate with the `registration_ac
`token_endpoint_auth_method`. It can be used to retrieve the OAuth2 Client.

```
GET /openid/register/{client_id}
GET /oauth2/register/{client_id}
Authorization: Bearer <registration_access_token>
Content-Type: application/json

Expand All @@ -111,6 +111,6 @@ The `DELETE` endpoint requires the client to authenticate with the `registration
`token_endpoint_auth_method`. It can be used to delete the OAuth2 Client.

```
DELETE /openid/register/{client_id}
DELETE /oauth2/register/{client_id}
Authorization: Bearer <registration_access_token>
```