ACL DELUSER - Upstash Documentation

Use ACL DELUSER to remove one or more ACL users and close any connections currently authenticated as them.

Multiple usernames can be deleted in a single call. The reply is the number of users that actually existed and were removed, which can be lower than the number of names passed in.

Syntax#

ACL DELUSER <username> [username ...]

Arguments#

Argument	Required	Repeatable	Description
`username`	Yes	Yes	Name of an ACL user to delete.

Important points#

The default user cannot be deleted; the command returns an error if it is included.
Deleting a user immediately terminates any of its active connections and subscriptions.

Response#

The reply reports the result of the operation. Error replies have the same shape in RESP2 and RESP3 and are surfaced as exceptions by the SDKs below.

Protocol	Reply
RESP2	Integer
RESP3	Integer

Note

Client libraries often decode bulk strings, maps, sets, and numeric strings into language-native values. The table describes the Redis wire reply.

Examples#

TCP examples use the TLS REDIS_URL from the Upstash console. REST examples use UPSTASH_REDIS_REST_URL and UPSTASH_REDIS_REST_TOKEN.

Redis CLI

ACL DELUSER app

@upstash/redis

Note

This command is not supported yet in @upstash/redis.

upstash_redis

Note

This command is not supported yet in upstash_redis.

ioredis

import Redis from "ioredis";const redis = new Redis(process.env.REDIS_URL!);const result = await redis.acl("DELUSER", "app");console.log(result);

node-redis

import { createClient } from "redis";const client = await createClient({ url: process.env.REDIS_URL })  .on("error", console.error)  .connect();const result = await client.aclDelUser("app");console.log(result);

redis-py

import osimport redisclient = redis.from_url(os.environ["REDIS_URL"])result = client.acl_deluser("app")print(result)

go-redis

Note

ACLDelUser accepts a single username per call. To delete more than one user, call it once per username.

package mainimport (    "context"    "fmt"    "os"    "github.com/redis/go-redis/v9")func main() {    opts, err := redis.ParseURL(os.Getenv("REDIS_URL"))    if err != nil {        panic(err)    }    client := redis.NewClient(opts)    result, err := client.ACLDelUser(context.Background(), "app").Result()    if err != nil {        panic(err)    }    fmt.Println(result)}

jedis

import java.net.URI;import redis.clients.jedis.Jedis;try (Jedis jedis = new Jedis(new URI(System.getenv("REDIS_URL")))) {  Object result = jedis.aclDelUser("app");  System.out.println(result);}

redis-rs

use redis::TypedCommands;fn main() -> redis::RedisResult<()> {    let url = std::env::var("REDIS_URL").expect("REDIS_URL is not set");    let client = redis::Client::open(url)?;    let mut connection = client.get_connection()?;    let result = connection.acl_deluser(&["app"])?;    println!("{result:?}");    Ok(())}