Links
Comment on page

UsersApi

All URIs are relative to https://api.ionos.com/databases/postgresql
Method
HTTP request
Description
DELETE /clusters/{clusterId}/users/{username}
Delete user
usersGet
GET /clusters/{clusterId}/users/{username}
Get user
usersList
GET /clusters/{clusterId}/users
List users
PATCH /clusters/{clusterId}/users/{username}
Patch user
usersPost
POST /clusters/{clusterId}/users
Create a user

usersDelete

usersDelete(clusterId, username)
Delete user
Deletes a single user

Examples

const ionoscloud = require('@ionos-cloud/sdk-nodejs-dbaas-postgres');
// setup authorization
const config = new ionoscloud.Configuration({
username: 'YOUR_USERNAME',
password: 'YOUR_PASSWORD',
apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.UsersApi(config);
// Delete user
api_instance
.usersDelete({
clusterId: 498ae72f-411f-11eb-9d07-046c59cc737e,
username: benjamin
})
.then((response) => console.log(response.data))
.catch((error) => console.log(error.response.data));

Parameters

Name
Type
Description
Notes
clusterId
string
The unique ID of the cluster.
[default to undefined]
username
string
The authentication username.
[default to undefined]

Return type

nil (empty response body)

Authorization

basicAuth, tokenAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

usersGet

usersGet(clusterId, username)
Get user
Retrieves a single user

Examples

const ionoscloud = require('@ionos-cloud/sdk-nodejs-dbaas-postgres');
// setup authorization
const config = new ionoscloud.Configuration({
username: 'YOUR_USERNAME',
password: 'YOUR_PASSWORD',
apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.UsersApi(config);
// Get user
api_instance
.usersGet({
clusterId: 498ae72f-411f-11eb-9d07-046c59cc737e,
username: benjamin
})
.then((response) => console.log(response.data))
.catch((error) => console.log(error.response.data));

Parameters

Name
Type
Description
Notes
clusterId
string
The unique ID of the cluster.
[default to undefined]
username
string
The authentication username.
[default to undefined]

Return type

Authorization

basicAuth, tokenAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

usersList

usersList(clusterId, opts)
List users
Retrieves a list of users

Examples

const ionoscloud = require('@ionos-cloud/sdk-nodejs-dbaas-postgres');
// setup authorization
const config = new ionoscloud.Configuration({
username: 'YOUR_USERNAME',
password: 'YOUR_PASSWORD',
apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.UsersApi(config);
// List users
api_instance
.usersList({
clusterId: 498ae72f-411f-11eb-9d07-046c59cc737e,
limit: 100,
offset: 200,
system: true,
options: {}
})
.then((response) => console.log(response.data))
.catch((error) => console.log(error.response.data));

Parameters

Name
Type
Description
Notes
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]

Return type

UserList

Authorization

basicAuth, tokenAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

usersPatch

usersPatch(clusterId, username, usersPatchRequest)
Patch user
Patches a single user. Only changing the password is supported. System users cannot be patched.

Examples

const ionoscloud = require('@ionos-cloud/sdk-nodejs-dbaas-postgres');
// setup authorization
const config = new ionoscloud.Configuration({
username: 'YOUR_USERNAME',
password: 'YOUR_PASSWORD',
apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.UsersApi(config);
// Patch user
api_instance
.usersPatch({
clusterId: 498ae72f-411f-11eb-9d07-046c59cc737e,
username: benjamin,
usersPatchRequest: usersPatchRequest_example
})
.then((response) => console.log(response.data))
.catch((error) => console.log(error.response.data));

Parameters

Name
Type
Description
Notes
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

Return type

Authorization

basicAuth, tokenAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

usersPost

usersPost(clusterId, user)
Create a user
Create a new Postgres User

Examples

const ionoscloud = require('@ionos-cloud/sdk-nodejs-dbaas-postgres');
// setup authorization
const config = new ionoscloud.Configuration({
username: 'YOUR_USERNAME',
password: 'YOUR_PASSWORD',
apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.UsersApi(config);
// Create a user
api_instance
.usersPost({
clusterId: 498ae72f-411f-11eb-9d07-046c59cc737e,
user: user_example
})
.then((response) => console.log(response.data))
.catch((error) => console.log(error.response.data));

Parameters

Name
Type
Description
Notes
clusterId
string
The unique ID of the cluster.
[default to undefined]
user
User

Return type

Authorization

basicAuth, tokenAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json