Control Plane Roles

List roles

List Redpanda Cloud roles.

get/v1/roles

Request

  • Base URL: https://api.redpanda.com
  • URL: https://api.redpanda.com/v1/roles
  • Auth: OAuth 2 (implicit, authorization URL https://auth.prd.cloud.redpanda.com/oauth/authorize)

Query parameters

filter.namestring
page_sizeinteger
page_tokenstring

Response

OK

next_page_tokenstring

Example response

{
  "roles": [
    {
      "description": "Billing Admins have access to billing information.",
      "name": "billing_admin"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.