REredpanda-data
Security

List roles

List roles. Optional: filter based on role name and principal.

get/v1/roles

Request

  • Base URL
    https://{dataplane_api_url}
  • Auth
    OAuth 2
    Implicit: https://auth.prd.cloud.redpanda.com/oauth/authorize

Query parameters

filter.name_prefixstring

Filter results only roles named with the prefix.

filter.name_containsstring

Filter results to only roles with names which contain the string.

filter.principalstring

Return only roles assigned to this principal. The principal must contain the principal type. For example: "User:jane" is a valid principal format.

page_sizeinteger

Page size.

page_tokenstring

Value of the next_page_token field returned by the previous response. If not provided, the system assumes the first page is requested.

Response

OK

next_page_tokenstring

Token to retrieve the next page.

Changes

No recorded changes to this operation across all 100 revisions of this API.