add keycloak client for external API token issuance#32
Merged
edandylytics merged 2 commits intodevelopmentfrom Mar 5, 2026
Merged
add keycloak client for external API token issuance#32edandylytics merged 2 commits intodevelopmentfrom
edandylytics merged 2 commits intodevelopmentfrom
Conversation
Configure a second Keycloak client (runway-api) for the client credentials flow so the external API can be tested locally without an external IdP. Adds create:jobs and partner:ea client scopes, an audience mapper, and updates .env.copyme with working defaults. Update docs with local development curl examples and fix the generic token request example to use form-encoded parameters. Made-with: Cursor
abfa34e to
2d6ec6e
Compare
bhaugeea
approved these changes
Mar 4, 2026
bhaugeea
left a comment
There was a problem hiding this comment.
Works great! Was super easy to spin up.
app/api/src/external-api/README.md
Outdated
|
|
||
| The local Keycloak instance (started by `docker compose`) comes pre-configured with a `runway-api` client for the external API. No additional IdP setup is needed. | ||
|
|
||
| The client is configured in [`api/keycloak/config.yaml`](../../../../api/keycloak/config.yaml) with the `create:jobs` and `partner:ea` scopes and an audience of `runway-local`. |
johncmerfeld
approved these changes
Mar 4, 2026
Collaborator
johncmerfeld
left a comment
There was a problem hiding this comment.
Worked great for me too!
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR allows Runway's external API to be used out of the box when running Runway locally, no setup or outside IdP required.
docker compose upshould apply the updated Keycloak config. Then run thecurlcommands in the README to test that it all works. You'll need to be running the API process:npx nx run api:serve. You may need to copy over the now-uncommented env vars fromapi/.env.copymeto your .env file