Skip to content

Commit

Permalink
docs: faq custom data (#2334)
Browse files Browse the repository at this point in the history
  • Loading branch information
vinckr committed Feb 2, 2021
1 parent 27dc147 commit 471e85d
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 0 deletions.
23 changes: 23 additions & 0 deletions docs/docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,29 @@ find an outdated section, please create a PR which removes or updates it!**

<!-- toc -->

## How can I store custom data ?

From [Github](https://github.com/ory/hydra/issues/2333)

> How can I store custom data in the client that can be retrieved along with the
> login request (using the challenge code)?
> I would like send in some metadata to the /oauth2/auth endpoint that can be
> retrievable by the "challenge code" that Hydra creates.
You can do this using the
[`request url`](https://github.com/ory/hydra/blob/27dc147a37c1cb98b7beb5428c389545958dd122/consent/types.go#L505).

Both Login and Consent Requests have a
[`request url`](https://github.com/ory/hydra/blob/27dc147a37c1cb98b7beb5428c389545958dd122/consent/types.go#L505)
which contains the original OAuth2 Authorize URL (e.g.
`/oauth2/auth?client_id=...&your_custom_param=....`)

```
RequestURL is the original OAuth 2.0 Authorization URL requested by the OAuth 2.0 client.
It is the URL which initiates the OAuth 2.0 Authorization Code or OAuth 2.0 Implicit flow.
This URL is typically not needed, but might come in handy if you want to deal with additional request parameters.
```

## How can I control SQL connection limits?

You can configure SQL connection limits by appending parameters `max_conns`,
Expand Down
23 changes: 23 additions & 0 deletions docs/versioned_docs/version-v1.9/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,29 @@ find an outdated section, please create a PR which removes or updates it!**

<!-- toc -->

## How can I store custom data ?

From [Github](https://github.com/ory/hydra/issues/2333)

> How can I store custom data in the client that can be retrieved along with the
> login request (using the challenge code)?
> I would like send in some metadata to the /oauth2/auth endpoint that can be
> retrievable by the "challenge code" that Hydra creates.
You can do this using the
[`request url`](https://github.com/ory/hydra/blob/27dc147a37c1cb98b7beb5428c389545958dd122/consent/types.go#L505).

Both Login and Consent Requests have a
[`request url`](https://github.com/ory/hydra/blob/27dc147a37c1cb98b7beb5428c389545958dd122/consent/types.go#L505)
which contains the original OAuth2 Authorize URL (e.g.
`/oauth2/auth?client_id=...&your_custom_param=....`)

```
RequestURL is the original OAuth 2.0 Authorization URL requested by the OAuth 2.0 client.
It is the URL which initiates the OAuth 2.0 Authorization Code or OAuth 2.0 Implicit flow.
This URL is typically not needed, but might come in handy if you want to deal with additional request parameters.
```

## How can I control SQL connection limits?

You can configure SQL connection limits by appending parameters `max_conns`,
Expand Down

0 comments on commit 471e85d

Please sign in to comment.