Control Plane Service Accounts

Update service account

Update a Redpanda Cloud service account.

patch/v1/service-accounts/{id}

Request

  • Base URL: https://api.redpanda.com
  • URL: https://api.redpanda.com/v1/service-accounts/{id}
  • Auth: OAuth 2 (implicit, authorization URL https://auth.prd.cloud.redpanda.com/oauth/authorize)

Path parameters

idstring required

Request body

update_maskstring

Example request

{
  "service_account": {
    "description": "CI bot account is used for CI workloads.",
    "name": "ci_bot"
  }
}

Response

Ok

Example response

{
  "service_account": {
    "auth0_client_credentials": {
      "client_id": "CDFX4567298",
      "client_secret": "dYz_FZqNM6E3_O1lKUwONKNQ4TKf7i"
    },
    "description": "CI bot account is used for CI workloads.",
    "name": "ci_bot"
  }
}

Changes

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