You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The Redpanda Cloud API is a collection of REST APIs that allow you to interact with different parts of Redpanda Cloud. The Control Plane API enables you to programmatically manage your organization's Redpanda infrastructure outside of the Cloud UI. You can call the API endpoints directly, or use tools like Terraform or Python scripts to automate cluster management.
9
12
@@ -13,18 +16,21 @@ See xref:api:ROOT:cloud-controlplane-api.adoc[Control Plane API] for the full AP
13
16
14
17
The Control Plane API is one central API that allows you to provision clusters, networks, and resource groups.
15
18
16
-
The Control Plane API consists of the following endpoints:
19
+
The Control Plane API consists of the following endpoint groups:
* pass:a,m[xref:{tag-service-accounts}[Control Plane Service Accounts\]]
28
34
29
35
// For serverless, show this section at the end of the doc
30
36
ifndef::env-serverless[]
@@ -353,22 +359,22 @@ endif::[]
353
359
354
360
== Manage RBAC
355
361
356
-
The available endpoints for managing xref:security:authorization/rbac.adoc[RBAC configurations], for example assigning xref:security:authorization/rbac.adoc#predefined-roles[roles] to a users and service accounts in the control plane, contain the version string `v1alpha1` in the path.
362
+
The endpoints for managing xref:security:authorization/rbac.adoc[RBAC configurations], for example assigning xref:security:authorization/rbac.adoc#predefined-roles[roles] to a users and service accounts in the control plane, contain the version string `v1alpha1` in the path.
357
363
358
364
=== List role bindings
359
365
360
366
To see role assignments for IAM user and service accounts, make a GET request to the xref:api:ROOT:cloud-controlplane-api.adoc#get-/v1alpha1/role-bindings[`/v1alpha1/role-bindings`] endpoint.
To see roles assignments for a specific IAM account, make a GET request to the xref:api:ROOT:cloud-controlplane-api.adoc#get-/v1alpha1/role-bindings/-id-[`/v1alpha1/role-bindings/\{id}`] endpoint.
377
+
To see roles assignments for a specific IAM account, make a GET request to the xref:api:ROOT:cloud-controlplane-api.adoc#get-/v1alpha1/role-bindings/-id-[`/v1alpha1/role-bindings/\{id}`] endpoint, passing the role binding ID as a parameter.
To see details of an IAM user account, make a GET request to the xref:api:ROOT:cloud-controlplane-api.adoc#get-/v1alpha1/users/-id-[`/v1alpha1/users/\{id}`] endpoint.
388
+
To see details of an IAM user account, make a GET request to the xref:api:ROOT:cloud-controlplane-api.adoc#get-/v1alpha1/users/-id-[`/v1alpha1/users/\{id}`] endpoint, passing the user account ID as a parameter.
To assign a role to an IAM user or service account, make a POST request to the xref:api:ROOT:cloud-controlplane-api.adoc#post-/v1alpha1/role-bindings[`/v1alpha1/role-bindings`] endpoint. Specify the role and resource scope in the request body.
399
+
To assign a role to an IAM user or service account, make a POST request to the xref:api:ROOT:cloud-controlplane-api.adoc#post-/v1alpha1/role-bindings[`/v1alpha1/role-bindings`] endpoint. Specify the role and scope, which includes the specific resource ID and an optional resource type, in the request body.
394
400
395
401
[,bash]
396
402
----
@@ -411,7 +417,7 @@ curl -X POST "https://api.redpanda.com/v1alpha1/role-bindings" \
411
417
412
418
NOTE: Service accounts are assigned the Admin role for all resources in the organization.
413
419
414
-
To create a new service account, make a POST request to the xref:api:ROOT:cloud-controlplane-api.adoc#post-/v1alpha1/service-accounts[`/v1alpha1/service-accounts`] endpoint.
420
+
To create a new service account, make a POST request to the xref:api:ROOT:cloud-controlplane-api.adoc#post-/v1alpha1/service-accounts[`/v1alpha1/service-accounts`] endpoint, with a service account name and optional description in the request body.
0 commit comments