rsdo 0.1.20260901

A Rust client library for the DigitalOcean API v2
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122

operationId: databases_add_user

summary: Add a Database User

description: |
  To add a new database user, send a POST request to `/v2/databases/$DATABASE_ID/users`
  with the desired username.

  Note: User management is not supported for Caching or Valkey clusters.

  When adding a user to a MySQL cluster, additional options can be configured in the
  `mysql_settings` object.

  When adding a user to a PostgreSQL cluster, additional options can be configured in
  the `settings` object (for example, `pg_allow_replication`). When
  `pg_allow_replication` is omitted, it defaults to `false`.

  When adding a user to a Kafka cluster, additional options can be configured in
  the `settings` object.

  When adding a user to a MongoDB cluster, additional options can be configured in
  the `settings.mongo_user_settings` object.

  The response will be a JSON object with a key called `user`. The value of this will be an
  object that contains the standard attributes associated with a database user including
  its randomly generated password.

tags:
  - Databases

parameters:
  - $ref: 'parameters.yml#/database_cluster_uuid'

requestBody:
  required: true
  content:
    application/json:
      schema:
        allOf:
        - $ref: 'models/database_user.yml'
        - type: object
          properties:
            readonly:
              type: boolean
              example: true
              description: |
                (To be deprecated: use settings.mongo_user_settings.role instead for access controls to MongoDB databases). 
                For MongoDB clusters, set to `true` to create a read-only user.
                This option is not currently supported for other database engines.
                           

      examples:
        Add New User:
          value:
            name: app-01

        Add New User with MySQL Auth Plugin:
          value:
            name: app-02
            mysql_settings:
              auth_plugin: mysql_native_password

        Add New Read Only User (MongoDB Only):
          value:
            name: my-readonly
            readonly: true

        Add New User that is restricted to a database (MongoDB Only):
          value:
            name: my-readWrite
            settings:
              mongo_user_settings:
                databases:
                  - my-db
                  - my-db-2
                role: readWrite
        
        Add New User for Postgres with replication rights:
          value:
            name: app-02
            settings:
              pg_allow_replication: true

        Add New User with Kafka ACLs:
          value:
            name: app-03
            settings:
              acl:
              - permission: produceconsume
                topic: customer-events
              - permission: produce
                topic: customer-events.*
              - permission: consume
                topic: customer-events

responses:
  '201':
    $ref: 'responses/user.yml'

  '401':
    $ref: '../../shared/responses/unauthorized.yml'

  '404':
    $ref: '../../shared/responses/not_found.yml'

  '429':
    $ref: '../../shared/responses/too_many_requests.yml'

  '500':
    $ref: '../../shared/responses/server_error.yml'

  default:
    $ref: '../../shared/responses/unexpected_error.yml'

x-codeSamples:
  - $ref: 'examples/curl/databases_add_user.yml'
  - $ref: 'examples/go/databases_add_user.yml'
  - $ref: 'examples/python/databases_add_user.yml'

security:
  - bearer_auth:
    - 'database:create'