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 builtin connector example #184

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
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
15 changes: 10 additions & 5 deletions content/docs/connectors/local.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ To specify users within the configuration file, the `staticPasswords` option can
* `username`: The username associated with the user.
* `userID`: The unique identifier (ID) of the user.

Users created via the configuration file are stored only in memory and not in the underlying configured storage.

#### Dynamic configuration (API)
Users can be dynamically managed via the gRPC API, offering a versatile method to handle user-related operations within the system.
Expand All @@ -52,6 +53,8 @@ Both local users and password grants are enabled, allowing the exchange of a tok

```yaml
issuer: http://localhost:8080/dex
web:
http: 127.0.0.1:8080
storage: # .. storage configuration
# Setup clients
staticClients:
Expand Down Expand Up @@ -83,24 +86,26 @@ oauth2:
Depending on whether you use a public or a private client you need to either include the just `clientId` or the `clientId` and `clientPassword` in the authorization header.

**Public Client**

```shell
curl -L -X POST 'http://localhost:8080/dex/token' \
-H 'Authorization: Basic cHVibGljLWNsaWVudAo=' \ # base64 encoded: public-client

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Basic auth is also acceptable. The current content is wrong.
Should be

    -H 'Authorization: Basic cHVibGljLWNsaWVudDo=' \

-H 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=password' \
--data-urlencode 'scope=openid profile' \
--data-urlencode 'username=admin@example.com' \
--data-urlencode 'password=admin'
--data-urlencode 'password=password' \
--data-urlencode 'client_id=public-client'
```


**Private Client**

```shell
curl -L -X POST 'http://localhost:8080/dex/token' \
-H 'Authorization: Basic cHJpdmF0ZS1jbGllbnQ6YXBwLXNlY3JldAo=' \ # base64 encoded: private-client:app-secret

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be

-H 'Authorization: Basic cHJpdmF0ZS1jbGllbnQ6YXBwLXNlY3JldA=' \ 
private-client:app-secret

-H 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=password' \
--data-urlencode 'scope=openid' \
--data-urlencode 'username=admin@example.com' \
--data-urlencode 'password=admin'
--data-urlencode 'password=password' \
--data-urlencode 'client_id=private-client' \
--data-urlencode 'client_secret=app-secret'
```