Give Feedback

database_user

Generated on 11 Feb 2026 from digitalocean.cloud version v1.2.1

Synopsis

Create or delete database users in a managed database cluster. View the API documentation at https://docs.digitalocean.com/reference/api/api-reference/#tag/Databases.

Requirements

pydo >= 0.1.3
azure-core >= 1.26.1

Parameters

Parameter	Choices / Default	Description
`client_override_options` dict		Client override options (developer use). For example, can be used to override the DigitalOcean API endpoint for an internal test suite. If provided, these options will knock out existing options.
`cluster_id` str / required		The UUID of the database cluster.
`module_override_options` dict		Module override options (developer use). Can be used to override module options to support experimental or future options. If provided, these options will knock out existing options.
`mysql_settings` dict		MySQL-specific settings for the user.
`name` str / required		The name of the database user.
`readonly` bool		For PostgreSQL and MySQL clusters, set to true to create a read-only user.
`state` str	Choices: `present` (default) `absent`	State of the resource, `present` to create, `absent` to destroy.
`timeout` int	Default: `300`	Polling timeout in seconds.
`token` str		DigitalOcean API token. There are several environment variables which can be used to provide this value. `DIGITALOCEAN_ACCESS_TOKEN`, `DIGITALOCEAN_TOKEN`, `DO_API_TOKEN`, `DO_API_KEY`, `DO_OAUTH_TOKEN` and `OAUTH_TOKEN`

Examples

- name: Create database user
  digitalocean.cloud.database_user:
    token: "{{ token }}"
    state: present
    cluster_id: 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30
    name: app_user

- name: Create read-only database user
  digitalocean.cloud.database_user:
    token: "{{ token }}"
    state: present
    cluster_id: 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30
    name: readonly_user
    readonly: true

- name: Delete database user
  digitalocean.cloud.database_user:
    token: "{{ token }}"
    state: absent
    cluster_id: 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30
    name: app_user

Return Values

Key Returned Description

Key	Returned	Description
`error` dict	failure	DigitalOcean API error. Sample: `{ "Message": "Informational error message.", "Reason": "Unauthorized", "Status Code": 401 }`
`msg` str	always	Database user result information. Sample: `[ "Created database user app_user", "Deleted database user app_user", "Database user app_user would be created", "Database user app_user exists", "Database user app_user does not exist" ]`
`user` dict	always	Database user information. Sample: `{ "mysql_settings": { "auth_plugin": "caching_sha2_password" }, "name": "app_user", "password": "example-password", "role": "normal" }`

error
dict

failure

DigitalOcean API error.
Sample:

{
  "Message": "Informational error message.",
  "Reason": "Unauthorized",
  "Status Code": 401
}

msg
str

always

Database user result information.
Sample:

[
  "Created database user app_user",
  "Deleted database user app_user",
  "Database user app_user would be created",
  "Database user app_user exists",
  "Database user app_user does not exist"
]

user
dict