pydo.databases.list_users()

Description

To list all of the users for your database cluster, send a GET request to /v2/databases/$DATABASE_ID/users.

Note: User management is not supported for Redis clusters.

The result will be a JSON object with a users key. This will be set to an array of database user objects, each of which will contain the standard database user attributes.

For MySQL clusters, additional options will be contained in the mysql_settings object.

Parameters

Request Sample

import os
from pydo import Client

client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN"))

get_resp = client.databases.list_users(database_cluster_uuid="a7aba3")

Responses

See the API spec for this endpoint to view additional detail on responses, headers, parameters, and more.

{
  "users": [
    {
      "name": "app-01",
      "role": "normal",
      "password": "jge5lfxtzhx42iff"
    },
    {
      "name": "doadmin",
      "role": "primary",
      "password": "wv78n3zpz42xezd"
    }
  ]
}

{
  "id": "unauthorized",
  "message": "Unable to authenticate you."
}

{
  "id": "not_found",
  "message": "The resource you requested could not be found."
}

{
  "id": "too_many_requests",
  "message": "API Rate limit exceeded."
}

{
  "id": "server_error",
  "message": "Unexpected server-side error"
}

{
  "id": "example_error",
  "message": "some error message"
}