Skip to content

feat(identity): how to rotate a client secret - #6463

Merged
juliamrch merged 4 commits into
release/kong-identity-m1from
iss4475-how-to
Jul 29, 2026
Merged

feat(identity): how to rotate a client secret#6463
juliamrch merged 4 commits into
release/kong-identity-m1from
iss4475-how-to

Conversation

@juliamrch

@juliamrch juliamrch commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

Description

This how-to guide shows how to rotate a client secret using the auth-server API.

closes #6339

Testing instructions

Replace .com by tech on the API calls.

Preview Links

https://deploy-preview-6463--kongdeveloper.netlify.app/how-to/rotate-auth-server-client-secrets/

Checklist

  • Tested how-to docs. If not, note why here.
  • All pages contain metadata.
  • Any new docs link to existing docs.
  • All autogenerated instructions render correctly (API, decK, Konnect, Kong Manager).
  • Style guide (capitalized gateway entities, placeholder URLs) implemented correctly.
  • Every page has a description entry in frontmatter.
  • Add new pages to the product documentation index (if applicable).

@juliamrch juliamrch self-assigned this Jul 27, 2026
@netlify

netlify Bot commented Jul 27, 2026

Copy link
Copy Markdown

Deploy Preview for kongdeveloper ready!

Name Link
🔨 Latest commit a251e02
🔍 Latest deploy log https://app.netlify.com/projects/kongdeveloper/deploys/6a69f6643bb0230007c10908
😎 Deploy Preview https://deploy-preview-6463--kongdeveloper.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@juliamrch
juliamrch changed the base branch from main to release/kong-identity-m1 July 27, 2026 16:23
@CLAassistant

CLAassistant commented Jul 27, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@juliamrch
juliamrch marked this pull request as ready for review July 27, 2026 16:26
@juliamrch
juliamrch requested a review from a team as a code owner July 27, 2026 16:26
@juliamrch juliamrch linked an issue Jul 28, 2026 that may be closed by this pull request

@lena-larionova lena-larionova left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Works great, just need to fix a couple of indents.

Comment thread app/_how-tos/gateway/rotate-auth-server-client-secrets.md Outdated
Comment thread app/_how-tos/gateway/rotate-auth-server-client-secrets.md Outdated
Comment thread app/_how-tos/gateway/rotate-auth-server-client-secrets.md Outdated
Comment thread app/_how-tos/gateway/rotate-auth-server-client-secrets.md Outdated
Comment thread app/_how-tos/gateway/rotate-auth-server-client-secrets.md Outdated
Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>
Comment thread app/_how-tos/gateway/rotate-auth-server-client-secrets.md Outdated
@juliamrch
juliamrch requested a review from lena-larionova July 29, 2026 10:35
Comment thread app/_how-tos/gateway/rotate-auth-server-client-secrets.md Outdated
Comment thread app/_how-tos/gateway/rotate-auth-server-client-secrets.md Outdated
Co-authored-by: Julia <101819212+juliamrch@users.noreply.github.com>

@tomek-labuk tomek-labuk left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks good and works! One minor suggestion that might not be applicable here, but as a user I might want to see some use case for this feature like: (maybe. add it somewhere in the tl;dr

  • Scheduled rotation, i.e. some compliance policies require rotating credentials on a fixed schedule.
  • Leaked secret: If a secret is exposed, you need to replace it without breaking anything using it.
  • Multiple consumers: If several services share one client, keeping both secrets active during rollout avoids breaking the ones that haven't switched yet.

@juliamrch
juliamrch merged commit d2c5bff into release/kong-identity-m1 Jul 29, 2026
13 checks passed
@juliamrch
juliamrch deleted the iss4475-how-to branch July 29, 2026 14:00
juliamrch added a commit that referenced this pull request Jul 30, 2026
* feat(identity): how to rotate a client secret (#6463)

* adapt Jessup instructions to a full guide

* Apply suggestions from code review

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* Apply suggestion from @juliamrch

* Apply suggestions from code review

Co-authored-by: Julia <101819212+juliamrch@users.noreply.github.com>

---------

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* feat(identity): multiple active secrets  (#6338)

* Port Kong Identity clients & secrets docs

Co-authored-by: ajessup <andrew.jessup@konghq.com>

Co-authored-by: Diana <diana.brezza@konghq.com>

* update Clients definition

* Apply suggestions from code review

Co-authored-by: Julia <101819212+juliamrch@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Julia <101819212+juliamrch@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Julia <101819212+juliamrch@users.noreply.github.com>

* Apply suggestion from @juliamrch

* Apply suggestions from code review

Co-authored-by: Julia <101819212+juliamrch@users.noreply.github.com>

* Remove OAuth2 authorization code flow comment

Removed the comment section detailing the authorization code flow for OAuth2.

* add how-to link

* Update auth-servers.md

Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Update auth-servers.md

Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Update auth-servers.md

Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* specify the options when generating a new secret with the API

* syntax + tables

---------

Co-authored-by: Diana <diana.brezza@konghq.com>
Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

---------

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>
Co-authored-by: Diana <diana.brezza@konghq.com>
Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

identity: how to rotate a client secrets

4 participants