Skip to content

feat(kotlin-client): support dynamic auth credentials for okhttp client (#23835)#23836

Open
manujell73 wants to merge 2 commits into
OpenAPITools:masterfrom
manujell73:kotlin-client-dynamic-auth-support
Open

feat(kotlin-client): support dynamic auth credentials for okhttp client (#23835)#23836
manujell73 wants to merge 2 commits into
OpenAPITools:masterfrom
manujell73:kotlin-client-dynamic-auth-support

Conversation

@manujell73
Copy link
Copy Markdown

@manujell73 manujell73 commented May 20, 2026

resolves #23835

This change adds dynamic credential/token provider support to Kotlin jvm-okhttp clients so auth values can be resolved at request time (instead of only using static ApiClient fields).

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (For Windows users, please run the script in WSL)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR solves a reported issue, reference it using GitHub's linking syntax (e.g., having "fixes #123" present in the PR description)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

Kotlin comittee:
@karismann (2019/03) @Zomzog (2019/04) @andrewemery (2019/10) @4brunu (2019/11) @yutaka0m (2020/03) @stefankoppier (2022/06) @e5l (2024/10) @dennisameling (2026/02)


Summary by cubic

Adds dynamic auth providers to Kotlin JVM okhttp clients so credentials/tokens are resolved per request. Enables rotating tokens and multi-tenant auth without rebuilding the client.

  • New Features
    • Added userCredentialsProvider and accessTokenProvider on ApiClient (assignable per instance); invoked at request time if Authorization is missing.
    • Supports Basic, Bearer, and OAuth schemes.
    • Backwards compatible: providers default to existing static fields.
    • Updated docs/samples to show static and dynamic setup (dynamic shown for JVM okhttp); fixed formatting and consistency.

Written for commit 9f56ca8. Summary will update on new commits. Review in cubic

Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai Bot left a comment

Choose a reason for hiding this comment

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

8 issues found across 61 files

Reply with feedback, questions, or to request a fix.

Re-trigger cubic

Comment thread modules/openapi-generator/src/main/resources/kotlin-client/api_doc.mustache Outdated
Comment thread samples/client/petstore/kotlin-jackson/docs/PetApi.md Outdated
Comment thread samples/client/others/kotlin-jvm-okhttp-non-ascii-headers/docs/PetApi.md Outdated
Comment thread samples/client/petstore/kotlin-jvm-vertx-moshi/docs/PetApi.md Outdated
Comment thread samples/client/echo_api/kotlin-jvm-spring-3-webclient/docs/AuthApi.md Outdated
Comment thread samples/client/petstore/kotlin-jvm-ktor-gson/docs/FakeApi.md Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[REQ][Kotlin] Support dynamic auth context for generated okhttp client

1 participant