UsersApi
Last updated
Last updated
All URIs are relative to https://api.ionos.com/databases/postgresql
Method | HTTP request | Description |
---|---|---|
usersDelete(clusterId, username)
Delete user
Deletes a single user
nil (empty response body)
basicAuth, tokenAuth
Content-Type: Not defined
Accept: application/json
usersGet(clusterId, username)
Get user
Retrieves a single user
basicAuth, tokenAuth
Content-Type: Not defined
Accept: application/json
usersList(clusterId, opts)
List users
Retrieves a list of users
basicAuth, tokenAuth
Content-Type: Not defined
Accept: application/json
usersPatch(clusterId, username, usersPatchRequest)
Patch user
Patches a single user. Only changing the password is supported. System users cannot be patched.
basicAuth, tokenAuth
Content-Type: application/json
Accept: application/json
usersPost(clusterId, user)
Create a user
Create a new Postgres User
basicAuth, tokenAuth
Content-Type: application/json
Accept: application/json
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
DELETE /clusters/{clusterId}/users/{username}
Delete user
GET /clusters/{clusterId}/users/{username}
Get user
GET /clusters/{clusterId}/users
List users
PATCH /clusters/{clusterId}/users/{username}
Patch user
POST /clusters/{clusterId}/users
Create a user
clusterId
string
The unique ID of the cluster.
[default to undefined]
username
string
The authentication username.
[default to undefined]
clusterId
string
The unique ID of the cluster.
[default to undefined]
username
string
The authentication username.
[default to undefined]
clusterId
string
The unique ID of the cluster.
[default to undefined]
limit
number
The maximum number of elements to return. Use together with 'offset' for pagination.
[optional][default to 100]
offset
number
The first element to return. Use together with 'limit' for pagination.
[optional][default to 0]
system
boolean
If set to 'true' all users, including system users are returned. System users cannot be deleted or updated.
[optional][default to undefined]
clusterId
string
The unique ID of the cluster.
[default to undefined]
username
string
The authentication username.
[default to undefined]
usersPatchRequest
Patch containing all properties that should be updated
clusterId
string
The unique ID of the cluster.
[default to undefined]
user