Links

UserManagementApi

All URIs are relative to https://api.ionos.com/cloudapi/v6
Method
HTTP request
Description
DELETE /um/groups/{groupId}
Delete groups
GET /um/groups/{groupId}
Retrieve groups
GET /um/groups
List all groups
POST /um/groups
Create groups
PUT /um/groups/{groupId}
Modify groups
GET /um/groups/{groupId}/resources
Retrieve group resources
DELETE /um/groups/{groupId}/shares/{resourceId}
Remove group shares
GET /um/groups/{groupId}/shares/{resourceId}
Retrieve group shares
GET /um/groups/{groupId}/shares
List group shares
POST /um/groups/{groupId}/shares/{resourceId}
Add group shares
PUT /um/groups/{groupId}/shares/{resourceId}
Modify group share privileges
DELETE /um/groups/{groupId}/users/{userId}
Remove users from groups
GET /um/groups/{groupId}/users
List group members
POST /um/groups/{groupId}/users
Add a Group Member
GET /um/resources/{resourceType}
List resources by type
GET /um/resources/{resourceType}/{resourceId}
Retrieve resources by type
GET /um/resources
List all resources
DELETE /um/users/{userId}
Delete users
GET /um/users/{userId}
Retrieve users
GET /um/users
List all users
GET /um/users/{userId}/groups
Retrieve group resources by user ID
GET /um/users/{userId}/owns
Retrieve user resources by user ID
POST /um/users
Create users
PUT /um/users/{userId}
Modify users

umGroupsDelete

umGroupsDelete(groupId, opts)
Delete groups
Remove the specified group.

Examples

const ionoscloud = require('@ionos-cloud/sdk-nodejs');
// setup authorization
const config = new ionoscloud.Configuration({
username: 'YOUR_USERNAME',
password: 'YOUR_PASSWORD',
apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.UserManagementApi(config);
// Delete groups
api_instance
.umGroupsDelete({
groupId: groupId_example,
pretty: true,
depth: 56,
xContractNumber: 56,
options: {}
})
.then((response) => console.log(response.data))
.catch((error) => console.log(error.response.data));

Parameters

Name
Type
Description
Notes
groupId
string
The unique ID of the group.
[default to undefined]
pretty
boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional][default to true]
depth
number
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[optional][default to 0]
xContractNumber
number
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional][default to undefined]

Return type

nil (empty response body)

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

umGroupsFindById

umGroupsFindById(groupId, opts)
Retrieve groups
Retrieve a group by the group ID. This value is in the response body when the group is created, and in the list of the groups, returned by GET.

Examples

const ionoscloud = require('@ionos-cloud/sdk-nodejs');
// setup authorization
const config = new ionoscloud.Configuration({
username: 'YOUR_USERNAME',
password: 'YOUR_PASSWORD',
apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.UserManagementApi(config);
// Retrieve groups
api_instance
.umGroupsFindById({
groupId: groupId_example,
pretty: true,
depth: 56,
xContractNumber: 56,
options: {}
})
.then((response) => console.log(response.data))
.catch((error) => console.log(error.response.data));

Parameters

Name
Type
Description
Notes
groupId
string
The unique ID of the group.
[default to undefined]
pretty
boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional][default to true]
depth
number
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[optional][default to 0]
xContractNumber
number
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional][default to undefined]

Return type

Group

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

umGroupsGet

umGroupsGet(opts)
List all groups
List all the available user groups.

Examples

const ionoscloud = require('@ionos-cloud/sdk-nodejs');
// setup authorization
const config = new ionoscloud.Configuration({
username: 'YOUR_USERNAME',
password: 'YOUR_PASSWORD',
apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.UserManagementApi(config);
var filterMap = new Map()
filterMap.set("<property_name>", "<property_value>")
// List all groups
api_instance
.umGroupsGet({
pretty: true,
depth: 56,
xContractNumber: 56
orderBy: "<property_name>"
maxResults: 2,
filters: filterMap
options: {}
})
.then((response) => console.log(response.data))
.catch((error) => console.log(error.response.data));

Parameters

Name
Type
Description
Notes
pretty
boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional][default to true]
depth
number
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children&#39;s children are included. - depth=... and so on
[optional][default to 0]
xContractNumber
number
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional][default to undefined]

Return type

Groups

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

umGroupsPost

umGroupsPost(group, opts)
Create groups
Create a group.

Examples

const ionoscloud = require('@ionos-cloud/sdk-nodejs');
// setup authorization
const config = new ionoscloud.Configuration({
username: 'YOUR_USERNAME',
password: 'YOUR_PASSWORD',
apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.UserManagementApi(config);
// Create groups
api_instance
.umGroupsPost({
group: group_example,
pretty: true,
depth: 56,
xContractNumber: 56,
options: {}
})
.then((response) => console.log(response.data))
.catch((error) => console.log(error.response.data));

Parameters

Name
Type
Description
Notes
group
Group
The group to create.
pretty
boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional][default to true]
depth
number
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children&#39;s children are included. - depth=... and so on
[optional][default to 0]
xContractNumber
number
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional][default to undefined]

Return type

Group

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

umGroupsPut

umGroupsPut(groupId, group, opts)
Modify groups
Modify the properties of the specified group.

Examples

const ionoscloud = require('@ionos-cloud/sdk-nodejs');
// setup authorization
const config = new ionoscloud.Configuration({
username: 'YOUR_USERNAME',
password: 'YOUR_PASSWORD',
apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.UserManagementApi(config);
// Modify groups
api_instance
.umGroupsPut({
groupId: groupId_example,
group: group_example,
pretty: true,
depth: 56,
xContractNumber: 56,
options: {}
})
.then((response) => console.log(response.data))
.catch((error) => console.log(error.response.data));

Parameters

Name
Type
Description
Notes
groupId
string
The unique ID of the group.
[default to undefined]
group
Group
The modified group.
pretty
boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional][default to true]
depth
number
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children&#39;s children are included. - depth=... and so on
[optional][default to 0]
xContractNumber
number
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional][default to undefined]

Return type

Group

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

umGroupsResourcesGet

umGroupsResourcesGet(groupId, opts)
Retrieve group resources
List the resources assigned to the group, by group ID.

Examples

const ionoscloud = require('@ionos-cloud/sdk-nodejs');
// setup authorization
const config = new ionoscloud.Configuration({
username: 'YOUR_USERNAME',
password: 'YOUR_PASSWORD',
apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.UserManagementApi(config);
var filterMap = new Map()
filterMap.set("<property_name>", "<property_value>")
// Retrieve group resources
api_instance
.umGroupsResourcesGet({
groupId: groupId_example,
pretty: true,
depth: 56,
xContractNumber: 56,
orderBy: "<property_name>"
maxResults: 2,
filters: filterMap
options: {}
})
.then((response) => console.log(response.data))
.catch((error) => console.log(error.response.data));

Parameters

Name
Type
Description
Notes
groupId
string
The unique ID of the group.
[default to undefined]
pretty
boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional][default to true]
depth
number
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children&#39;s children are included. - depth=... and so on
[optional][default to 0]
xContractNumber
number
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional][default to undefined]

Return type

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

umGroupsSharesDelete

umGroupsSharesDelete(groupId, resourceId, opts)
Remove group shares
Remove the specified share from the group.

Examples

const ionoscloud = require('@ionos-cloud/sdk-nodejs');
// setup authorization
const config = new ionoscloud.Configuration({
username: 'YOUR_USERNAME',
password: 'YOUR_PASSWORD',
apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.UserManagementApi(config);
// Remove group shares
api_instance
.umGroupsSharesDelete({
groupId: groupId_example,
resourceId: resourceId_example,
pretty: true,
depth: 56,
xContractNumber: 56,
options: {}
})
.then((response) => console.log(response.data))
.catch((error) => console.log(error.response.data));

Parameters

Name
Type
Description
Notes
groupId
string
The unique ID of the group.
[default to undefined]
resourceId
string
The unique ID of the resource.
[default to undefined]
pretty
boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional][default to true]
depth
number
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children&#39;s children are included. - depth=... and so on
[optional][default to 0]
xContractNumber
number
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional][default to undefined]

Return type

nil (empty response body)

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

umGroupsSharesFindByResourceId

umGroupsSharesFindByResourceId(groupId, resourceId, opts)
Retrieve group shares
Retrieve the properties of the specified group share.

Examples

const ionoscloud = require('@ionos-cloud/sdk-nodejs');
// setup authorization
const config = new ionoscloud.Configuration({
username: 'YOUR_USERNAME',
password: 'YOUR_PASSWORD',
apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.UserManagementApi(config);
// Retrieve group shares
api_instance
.umGroupsSharesFindByResourceId({
groupId: groupId_example,
resourceId: resourceId_example,
pretty: true,
depth: 56,
xContractNumber: 56,
options: {}
})
.then((response) => console.log(response.data))
.catch((error) => console.log(error.response.data));

Parameters

Name
Type
Description
Notes
groupId
string
The unique ID of the group.
[default to undefined]
resourceId
string
The unique ID of the resource.
[default to undefined]
pretty
boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional][default to true]
depth
number
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children&#39;s children are included. - depth=... and so on
[optional][default to 0]
xContractNumber
number
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional][default to undefined]

Return type

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

umGroupsSharesGet

umGroupsSharesGet(groupId, opts)
List group shares
List all shares and share privileges for the specified group.

Examples

const ionoscloud = require('@ionos-cloud/sdk-nodejs');
// setup authorization
const config = new ionoscloud.Configuration({
username: 'YOUR_USERNAME',
password: 'YOUR_PASSWORD',
apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.UserManagementApi(config);
var filterMap = new Map()
filterMap.set("<property_name>", "<property_value>")
// List group shares
api_instance
.umGroupsSharesGet({
groupId: groupId_example,
pretty: true,
depth: 56,
xContractNumber: 56,
orderBy: "<property_name>"
maxResults: 2,
filters: filterMap
options: {}
})
.then((response) => console.log(response.data))
.catch((error) => console.log(error.response.data));

Parameters