Skip to content

rpk cloud auth token reference #605

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.

Sign up for GitHub

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

Merged
kbatuigas merged 3 commits into from
May 29, 2026
Merged

rpk cloud auth token reference #605

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e0011e9
Add rpk cloud auth token reference page and xrefs from SQL docs
kbatuigas May 29, 2026
a94f05f
Temporarily use docs feature branch to import partial
kbatuigas May 29, 2026
9bdc7fd
Update local-antora-playbook.yml
kbatuigas May 29, 2026
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
1 change: 1 addition & 0 deletions modules/ROOT/nav.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -793,6 +793,7 @@
**** xref:reference:rpk/rpk-cloud/rpk-cloud-auth.adoc[]
***** xref:reference:rpk/rpk-cloud/rpk-cloud-auth-delete.adoc[]
***** xref:reference:rpk/rpk-cloud/rpk-cloud-auth-list.adoc[]
***** xref:reference:rpk/rpk-cloud/rpk-cloud-auth-token.adoc[]
***** xref:reference:rpk/rpk-cloud/rpk-cloud-auth-use.adoc[]
**** xref:reference:rpk/rpk-cloud/rpk-cloud-byoc.adoc[]
***** xref:reference:rpk/rpk-cloud/rpk-cloud-byoc-install.adoc[]
Expand Down
3 changes: 3 additions & 0 deletions modules/reference/pages/rpk/rpk-cloud/rpk-cloud-auth-token.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
= rpk cloud auth token

include::streaming:reference:partial$rpk-cloud/rpk-cloud-auth-token.adoc[tag=single-source]
2 changes: 1 addition & 1 deletion modules/sql/pages/connect-to-sql/authenticate.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Redpanda SQL supports three authentication modes, selected by the connection-str

|Bearer token
|`auth_method=bearer`
|You already hold a JSON Web Token (JWT) issued by Redpanda Cloud (for example, returned by `rpk cloud auth token`).
|You already hold a JSON Web Token (JWT) issued by Redpanda Cloud (for example, returned by xref:reference:rpk/rpk-cloud/rpk-cloud-auth-token.adoc[`rpk cloud auth token`]).

|Client credentials
|`auth_method=client_secret`
Expand Down
2 changes: 1 addition & 1 deletion modules/sql/pages/get-started/deploy-sql-cluster.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ To connect using a bearer token (xref:manage:rpk/rpk-install.adoc[`rpk` v26.1.6+
rpk cloud login
----

. Retrieve a temporary authentication token for the SQL engine:
. Retrieve a temporary authentication token for the SQL engine using xref:reference:rpk/rpk-cloud/rpk-cloud-auth-token.adoc[`rpk cloud auth token`]:
+
[,bash]
----
Expand Down
2 changes: 1 addition & 1 deletion modules/sql/pages/get-started/sql-quickstart.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ SQL connection details are available on your cluster's *SQL* tab in the https://
rpk cloud login
----

. Retrieve a temporary authentication token for the SQL engine:
. Retrieve a temporary authentication token for the SQL engine using xref:reference:rpk/rpk-cloud/rpk-cloud-auth-token.adoc[`rpk cloud auth token`]:
+
[,bash]
----
Expand Down