Users
All operations require authentication.
List usersBeta
Returns the users of the service with their access rules and status. Passwords are not returned.
Path parameters
Project ID
Service ID
Headers
Pagination cursor
Pagination size
Response
Whether this is the service administrator, the user created automatically at provisioning time, which cannot be deleted
Command category rules granted to the user, each written as a category name prefixed with +@ when it is allowed or -@ when it is denied, for example +@read, -@dangerous
Glob patterns of the Pub/Sub channels the user can subscribe to and publish on, for example news:*, chat:room1. * means every channel, and an empty list means the user cannot use any channel.
Hash of the resource used for concurrency control
Individual command rules refining the permissions granted through the categories, each written as a Valkey command name prefixed with + when it is allowed or - when it is denied, for example +get, -flushall
Date at which the user was created
Date at which the user credentials were last updated
Unique identifier of the user
Glob patterns of the keys the user can access, for example cache:*, session:user:42. * means every key, and an empty list means the user cannot access any key.
Password of the user. Returned only on creation or password reset.
Current readiness status of the user
CREATINGDELETINGERRORREADYUPDATINGLogin name of the user
Example uses projectId = string, serviceId = 00000000-0000-0000-0000-000000000000
$ curl https:/[ { "admin": true, "categories": [ "string" ], "channels": [ "string" ], "checksum": "string", "commands": [ "string" ], "createdAt": "2024-01-01T12:00:00Z", "credentialsLastUpdatedAt": "2024-01-01T12:00:00Z", "id": "00000000-0000-0000-0000-000000000000", "keys": [ "string" ], "password": "string", "status": "CREATING", "username": "string" }]
Get a userBeta
Returns the user, its access rules and its status. The password is not returned.
Path parameters
Project ID
Service ID
User ID
Response
Whether this is the service administrator, the user created automatically at provisioning time, which cannot be deleted
Command category rules granted to the user, each written as a category name prefixed with +@ when it is allowed or -@ when it is denied, for example +@read, -@dangerous
Glob patterns of the Pub/Sub channels the user can subscribe to and publish on, for example news:*, chat:room1. * means every channel, and an empty list means the user cannot use any channel.
Hash of the resource used for concurrency control
Individual command rules refining the permissions granted through the categories, each written as a Valkey command name prefixed with + when it is allowed or - when it is denied, for example +get, -flushall
Date at which the user was created
Date at which the user credentials were last updated
Unique identifier of the user
Glob patterns of the keys the user can access, for example cache:*, session:user:42. * means every key, and an empty list means the user cannot access any key.
Password of the user. Returned only on creation or password reset.
Current readiness status of the user
CREATINGDELETINGERRORREADYUPDATINGLogin name of the user
Example uses projectId = string, serviceId = 00000000-0000-0000-0000-000000000000, userId = 00000000-0000-0000-0000-000000000000
$ curl https:/{ "admin": true, "categories": [ "string" ], "channels": [ "string" ], "checksum": "string", "commands": [ "string" ], "createdAt": "2024-01-01T12:00:00Z", "credentialsLastUpdatedAt": "2024-01-01T12:00:00Z", "id": "00000000-0000-0000-0000-000000000000", "keys": [ "string" ], "password": "string", "status": "CREATING", "username": "string"}
Create a userBeta
Creates a user with access rules on command categories, commands, keys and Pub/Sub channels. An empty keys or channels list grants no access. The generated password is returned only on creation and on password reset.
Path parameters
Project ID
Service ID
Request body (required)
Command category rules granted to the user, each written as a category name prefixed with +@ to allow it or -@ to deny it, for example +@read, -@dangerous. Available categories are all, admin, bitmap, blocking, connection, dangerous, fast, geo, hash, hyperloglog, keyspace, list, pubsub, read, scripting, set, slow, sortedset, stream, string, transaction and write.
Glob patterns of the Pub/Sub channels the user can subscribe to and publish on, for example news:*, chat:room1. Use * to allow every channel. When the list is empty, the user cannot use any channel.
Individual command rules that refine the permissions granted through the categories, each written as a Valkey command name in lowercase prefixed with + to allow it or - to deny it, for example +get, -flushall
Glob patterns of the keys the user can access, for example cache:*, session:user:42. Use * to allow every key. When the list is empty, the user cannot access any key.
Login name of the new user, unique on the service. It must be 1 to 32 characters long, start with a letter, a digit or an underscore, and contain only letters, digits, underscores, dots and hyphens.
Response
Whether this is the service administrator, the user created automatically at provisioning time, which cannot be deleted
Command category rules granted to the user, each written as a category name prefixed with +@ when it is allowed or -@ when it is denied, for example +@read, -@dangerous
Glob patterns of the Pub/Sub channels the user can subscribe to and publish on, for example news:*, chat:room1. * means every channel, and an empty list means the user cannot use any channel.
Hash of the resource used for concurrency control
Individual command rules refining the permissions granted through the categories, each written as a Valkey command name prefixed with + when it is allowed or - when it is denied, for example +get, -flushall
Date at which the user was created
Date at which the user credentials were last updated
Unique identifier of the user
Glob patterns of the keys the user can access, for example cache:*, session:user:42. * means every key, and an empty list means the user cannot access any key.
Password of the user. Returned only on creation or password reset.
Current readiness status of the user
CREATINGDELETINGERRORREADYUPDATINGLogin name of the user
Example uses projectId = string, serviceId = 00000000-0000-0000-0000-000000000000
$ curl https:/{ "admin": true, "categories": [ "string" ], "channels": [ "string" ], "checksum": "string", "commands": [ "string" ], "createdAt": "2024-01-01T12:00:00Z", "credentialsLastUpdatedAt": "2024-01-01T12:00:00Z", "id": "00000000-0000-0000-0000-000000000000", "keys": [ "string" ], "password": "string", "status": "CREATING", "username": "string"}
Delete a userBeta
Permanently deletes the user.
Path parameters
Project ID
Service ID
User ID
Response
Whether this is the service administrator, the user created automatically at provisioning time, which cannot be deleted
Command category rules granted to the user, each written as a category name prefixed with +@ when it is allowed or -@ when it is denied, for example +@read, -@dangerous
Glob patterns of the Pub/Sub channels the user can subscribe to and publish on, for example news:*, chat:room1. * means every channel, and an empty list means the user cannot use any channel.
Hash of the resource used for concurrency control
Individual command rules refining the permissions granted through the categories, each written as a Valkey command name prefixed with + when it is allowed or - when it is denied, for example +get, -flushall
Date at which the user was created
Date at which the user credentials were last updated
Unique identifier of the user
Glob patterns of the keys the user can access, for example cache:*, session:user:42. * means every key, and an empty list means the user cannot access any key.
Password of the user. Returned only on creation or password reset.
Current readiness status of the user
CREATINGDELETINGERRORREADYUPDATINGLogin name of the user
Example uses projectId = string, serviceId = 00000000-0000-0000-0000-000000000000, userId = 00000000-0000-0000-0000-000000000000
$ curl https:/{ "admin": true, "categories": [ "string" ], "channels": [ "string" ], "checksum": "string", "commands": [ "string" ], "createdAt": "2024-01-01T12:00:00Z", "credentialsLastUpdatedAt": "2024-01-01T12:00:00Z", "id": "00000000-0000-0000-0000-000000000000", "keys": [ "string" ], "password": "string", "status": "CREATING", "username": "string"}
Update a userBeta
Updates the access rules of the user. Each list replaces the current one, and an empty keys or channels list revokes all access. To reset the password, use the resetPassword route of the user or a partial update with credentialsLastUpdatedAt.
Path parameters
Project ID
Service ID
User ID
Request body (required)
Command category rules granted to the user, each written as a category name prefixed with +@ to allow it or -@ to deny it, for example +@read, -@dangerous. Available categories are all, admin, bitmap, blocking, connection, dangerous, fast, geo, hash, hyperloglog, keyspace, list, pubsub, read, scripting, set, slow, sortedset, stream, string, transaction and write. The list replaces the one currently set on the user.
Glob patterns of the Pub/Sub channels the user can subscribe to and publish on, for example news:*, chat:room1. Use * to allow every channel. The list replaces the one currently set on the user, and an empty list revokes access to every channel.
Individual command rules that refine the permissions granted through the categories, each written as a Valkey command name in lowercase prefixed with + to allow it or - to deny it, for example +get, -flushall. The list replaces the one currently set on the user.
Glob patterns of the keys the user can access, for example cache:*, session:user:42. Use * to allow every key. The list replaces the one currently set on the user, and an empty list revokes access to every key.
Response
Whether this is the service administrator, the user created automatically at provisioning time, which cannot be deleted
Command category rules granted to the user, each written as a category name prefixed with +@ when it is allowed or -@ when it is denied, for example +@read, -@dangerous
Glob patterns of the Pub/Sub channels the user can subscribe to and publish on, for example news:*, chat:room1. * means every channel, and an empty list means the user cannot use any channel.
Hash of the resource used for concurrency control
Individual command rules refining the permissions granted through the categories, each written as a Valkey command name prefixed with + when it is allowed or - when it is denied, for example +get, -flushall
Date at which the user was created
Date at which the user credentials were last updated
Unique identifier of the user
Glob patterns of the keys the user can access, for example cache:*, session:user:42. * means every key, and an empty list means the user cannot access any key.
Password of the user. Returned only on creation or password reset.
Current readiness status of the user
CREATINGDELETINGERRORREADYUPDATINGLogin name of the user
Example uses projectId = string, serviceId = 00000000-0000-0000-0000-000000000000, userId = 00000000-0000-0000-0000-000000000000
$ curl https:/{ "admin": true, "categories": [ "string" ], "channels": [ "string" ], "checksum": "string", "commands": [ "string" ], "createdAt": "2024-01-01T12:00:00Z", "credentialsLastUpdatedAt": "2024-01-01T12:00:00Z", "id": "00000000-0000-0000-0000-000000000000", "keys": [ "string" ], "password": "string", "status": "CREATING", "username": "string"}
Partially update a userBeta
Partially updates the access rules of the user. Each list replaces the current one, and an empty keys or channels list revokes all access. Setting credentialsLastUpdatedAt resets the password and returns the new one.
Path parameters
Project ID
Service ID
User ID
Request body (required)
Command category rules granted to the user, each written as a category name prefixed with +@ to allow it or -@ to deny it, for example +@read, -@dangerous. Available categories are all, admin, bitmap, blocking, connection, dangerous, fast, geo, hash, hyperloglog, keyspace, list, pubsub, read, scripting, set, slow, sortedset, stream, string, transaction and write. The list replaces the one currently set on the user.
Glob patterns of the Pub/Sub channels the user can subscribe to and publish on, for example news:*, chat:room1. Use * to allow every channel. The list replaces the one currently set on the user, and an empty list revokes access to every channel.
Individual command rules that refine the permissions granted through the categories, each written as a Valkey command name in lowercase prefixed with + to allow it or - to deny it, for example +get, -flushall. The list replaces the one currently set on the user.
Date at which the user credentials were last updated. Setting this field triggers a credential reset and returns the new password.
Glob patterns of the keys the user can access, for example cache:*, session:user:42. Use * to allow every key. The list replaces the one currently set on the user, and an empty list revokes access to every key.
Response
Whether this is the service administrator, the user created automatically at provisioning time, which cannot be deleted
Command category rules granted to the user, each written as a category name prefixed with +@ when it is allowed or -@ when it is denied, for example +@read, -@dangerous
Glob patterns of the Pub/Sub channels the user can subscribe to and publish on, for example news:*, chat:room1. * means every channel, and an empty list means the user cannot use any channel.
Hash of the resource used for concurrency control
Individual command rules refining the permissions granted through the categories, each written as a Valkey command name prefixed with + when it is allowed or - when it is denied, for example +get, -flushall
Date at which the user was created
Date at which the user credentials were last updated
Unique identifier of the user
Glob patterns of the keys the user can access, for example cache:*, session:user:42. * means every key, and an empty list means the user cannot access any key.
Password of the user. Returned only on creation or password reset.
Current readiness status of the user
CREATINGDELETINGERRORREADYUPDATINGLogin name of the user
Example uses projectId = string, serviceId = 00000000-0000-0000-0000-000000000000, userId = 00000000-0000-0000-0000-000000000000
$ curl https:/{ "admin": true, "categories": [ "string" ], "channels": [ "string" ], "checksum": "string", "commands": [ "string" ], "createdAt": "2024-01-01T12:00:00Z", "credentialsLastUpdatedAt": "2024-01-01T12:00:00Z", "id": "00000000-0000-0000-0000-000000000000", "keys": [ "string" ], "password": "string", "status": "CREATING", "username": "string"}
Reset the password of a userBeta
Generates a new password for the user and returns it in the response. Reading the user never returns it. The previous password stops working once the new one is applied, and credentialsLastUpdatedAt becomes the date of this reset. This is the same reset as a partial update of the user that sets credentialsLastUpdatedAt.
Path parameters
Project ID
Service ID
User ID
Response
Whether this is the service administrator, the user created automatically at provisioning time, which cannot be deleted
Command category rules granted to the user, each written as a category name prefixed with +@ when it is allowed or -@ when it is denied, for example +@read, -@dangerous
Glob patterns of the Pub/Sub channels the user can subscribe to and publish on, for example news:*, chat:room1. * means every channel, and an empty list means the user cannot use any channel.
Hash of the resource used for concurrency control
Individual command rules refining the permissions granted through the categories, each written as a Valkey command name prefixed with + when it is allowed or - when it is denied, for example +get, -flushall
Date at which the user was created
Date at which the user credentials were last updated
Unique identifier of the user
Glob patterns of the keys the user can access, for example cache:*, session:user:42. * means every key, and an empty list means the user cannot access any key.
Password of the user. Returned only on creation or password reset.
Current readiness status of the user
CREATINGDELETINGERRORREADYUPDATINGLogin name of the user
Example uses projectId = string, serviceId = 00000000-0000-0000-0000-000000000000, userId = 00000000-0000-0000-0000-000000000000
$ curl https:/{ "admin": true, "categories": [ "string" ], "channels": [ "string" ], "checksum": "string", "commands": [ "string" ], "createdAt": "2024-01-01T12:00:00Z", "credentialsLastUpdatedAt": "2024-01-01T12:00:00Z", "id": "00000000-0000-0000-0000-000000000000", "keys": [ "string" ], "password": "string", "status": "CREATING", "username": "string"}