---
title: "Create a new Redis Software user"
method: POST
path: "/v1/users"
tags: ["Users"]
---

# Create a new Redis Software user

`POST /v1/users`

Create a new user with the provided configuration

## Query parameters

- `dry_run` boolean

## Request body

- UserRequest — User modification request.
  - `account_id` integer — SM account ID
  - `auth_method` 'regular' | 'certificate' | 'entraid' | 'sso'
  - `bdbs_email_alerts` string[] — UIDs of databases that user will receive alerts for.
  - `certificate_subject_line` string — The certificate's subject line as defined by RFC2253 (for certificate based authentication users only)
  - `cluster_email_alerts` boolean — Activate cluster email alerts for a user.
  - `email` string — User's email.
  - `email_alerts` boolean — Activate email alerts for a user.
  - `name` string — User's name. (pattern does not allow non ascii and special characters &,<,>,")
  - `password` string — User's password for regular authentication. Required for regular auth method.
  - `password_hash_method` 1 — Used when password is passed pre-hashed
  - `role` 'none' | 'db_viewer' | 'cluster_viewer' | 'db_member' | 'cluster_member' | 'user_manager' | 'admin' — Name of the management role.
  - `role_uids` integer[] — List of role uids associated with the user
  - `uid` integer — User's unique uid.

## Response `200`

User created successfully

- User — An API object that represents an Redis Software Cluster user.
  - `account_id` integer — SM account ID
  - `action_uid` string — Action uid. If exists - progress can be tracked by the GET /actions/<uid> API
  - `auth_method` 'regular' | 'certificate' | 'entraid' | 'sso', required
  - `bdbs_email_alerts` string[] — UIDs of databases that user will receive alerts for.
  - `certificate_subject_line` string — The certificate's subject line as defined by RFC2253 (for certificate based authentication users only)
  - `cluster_email_alerts` boolean — Activate cluster email alerts for a user.
  - `email` string — User's email. (pattern matching only ascii characters)
  - `email_alerts` boolean — Activate email alerts for a user.
  - `last_login` integer — Timestamp of the user's last login time. This denotes the last time an authentication with the user's credentials was successful.
  - `name` string, required — User's name. (pattern does not allow non ascii and special characters &,<,>,")
  - `password` string — User's password. Note that it could also be an already-hashed value, in which case 'password_hash_method' parameter is also provided.
  - `password_issue_date` string, date-time — The date in which the password was set.
  - `role` 'none' | 'db_viewer' | 'cluster_viewer' | 'db_member' | 'cluster_member' | 'user_manager' | 'admin', required — Name of the management role.
  - `role_uids` integer[], required — List of role uids associated with the user
  - `status` 'active' | 'locked' | 'password_expired' — Status of the user.
  - `uid` integer, required — User's unique uid.

## Other responses

- `400` — Bad Request
- `403` — Forbidden
- `409` — User with the same email or name already exists

---

[API](https://skmtc.dev/redis/apis/redis-software-rest-api.md) · [All operations](https://skmtc.dev/redis/apis/redis-software-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/redis/redis-software-rest-api/revisions/caec2005b95b/schema)