REredis
Roles

Update a Redis Software role

Changed on

Update a role configuration by unique ID.

put/v1/roles/{uid}

Request

  • Base URL
    https://localhost:9443
  • URL
    https://localhost:9443/v1/roles/{uid}
  • Auth
    API key in header r-auth-user

Path parameters

uidinteger required

The role unique ID.

Query parameters

dry_runboolean

Validate the request without persisting changes.

Request body

account_idinteger

Account ID. Only applicable to account-scoped roles.

management'none' | 'db_viewer' | 'cluster_viewer' | 'db_member' | 'cluster_member' | 'user_manager' | 'admin'

Name of the management role.

namestring

Role's name.

Example request

{
  "management": "cluster_member"
}

Response

Role updated successfully.

account_idinteger

Account ID. Only applicable to account-scoped roles.

management'none' | 'db_viewer' | 'cluster_viewer' | 'db_member' | 'cluster_member' | 'user_manager' | 'admin' required

Name of the management role.

namestring required

Role's name.

uidinteger required

Role's unique uid.

Example response

{
  "management": "cluster_member",
  "name": "DBA",
  "uid": 1
}

Changes

  • 75fcb952f0c6Revision changes
    • warning

      removed the request property ////

    • warning

      removed the optional property //// from the response with the status

  • a19324f2815bRevision changes
    • breaking

      removed the enum value bdb of the request property //////

    • warning

      added the new db enum value to the ////// response property for the response status

    • info

      added the new db enum value to the request property //////

    • info

      removed the bdb enum value from the ////// response property for the response status