Redis User V2

Create a Redis User.

SecurityBasic Authentication
Request
Request Body schema: application/json
password
required
string <password>

Password for the Redis user.

clusterId
required
string <uuid>

ID of the Redis cluster.

initialPermissions
required
string

Permissions initially granted to Redis user upon creation.

Enum: "standard" "read-only" "none"
username
required
string^(?![zZ][oO][oO][kK][eE][eE][pP][eE][rR]$)[a-...

Username of the Redis user.

Responses
202

Redis user provisioning requested.

post/cluster-management/v2/resources/applications/redis/users/v2/
Request samples
application/json
{
  • "clusterId": "c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37",
  • "id": "c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37_myRedisUser",
  • "initialPermissions": "standard",
  • "password": "myPassword0.",
  • "username": "myRedisUser"
}
Response samples
application/json
{
  • "clusterId": "c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37",
  • "id": "c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37_myRedisUser",
  • "initialPermissions": "standard",
  • "password": "myPassword0.",
  • "username": "myRedisUser"
}

Get Redis User details.

SecurityBasic Authentication
Request
path Parameters
redisUserId
required
string

ID of the Redis user.

Responses
200

Redis user details retrieved.

get/cluster-management/v2/resources/applications/redis/users/v2/{redisUserId}/
Request samples
Response samples
application/json
{
  • "clusterId": "c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37",
  • "id": "c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37_myRedisUser",
  • "initialPermissions": "standard",
  • "password": "myPassword0.",
  • "username": "myRedisUser"
}

Update Redis user password

SecurityBasic Authentication
Request
path Parameters
redisUserId
required
string

ID of the Redis user.

Request Body schema: application/json
password
required
string <password>

Password for the Redis user.

Responses
200

Requested Redis user's password update.

404

Redis cluster not found.

503

Service Unavailable

504

Gateway Timeout

put/cluster-management/v2/resources/applications/redis/users/v2/{redisUserId}/
Request samples
application/json
{
  • "password": "my1password!"
}
Response samples
application/json
{
  • "password": "my1password!"
}

Delete a Redis user

SecurityBasic Authentication
Request
path Parameters
redisUserId
required
string

ID of the Redis user.

Responses
204

Redis user delete requested.

delete/cluster-management/v2/resources/applications/redis/users/v2/{redisUserId}/
Request samples