All URIs are relative to https://api.ionos.com/cloudapi/v6
umGroupsDelete
umGroupsDelete(groupId, opts)
Delete groups
Remove the specified group.
Examples
Copy 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
Return type
nil (empty response body)
Authorization
Basic Authentication, Token Authentication
Content-Type : Not defined
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
Copy 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
Return type
Group
Authorization
Basic Authentication, Token Authentication
Content-Type : Not defined
umGroupsGet
umGroupsGet(opts)
List all groups
List all the available user groups.
Examples
Copy 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
Return type
Groups
Authorization
Basic Authentication, Token Authentication
Content-Type : Not defined
umGroupsPost
umGroupsPost(group, opts)
Create groups
Create a group.
Examples
Copy 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
Return type
Group
Authorization
Basic Authentication, Token Authentication
Content-Type : application/json
umGroupsPut
umGroupsPut(groupId, group, opts)
Modify groups
Modify the properties of the specified group.
Examples
Copy 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
Return type
Group
Authorization
Basic Authentication, Token Authentication
Content-Type : application/json
umGroupsResourcesGet
umGroupsResourcesGet(groupId, opts)
Retrieve group resources
List the resources assigned to the group, by group ID.
Examples
Copy 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
Return type
ResourceGroups
Authorization
Basic Authentication, Token Authentication
Content-Type : Not defined
umGroupsSharesDelete
umGroupsSharesDelete(groupId, resourceId, opts)
Remove group shares
Remove the specified share from the group.
Examples
Copy 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
Return type
nil (empty response body)
Authorization
Basic Authentication, Token Authentication
Content-Type : Not defined
umGroupsSharesFindByResourceId
umGroupsSharesFindByResourceId(groupId, resourceId, opts)
Retrieve group shares
Retrieve the properties of the specified group share.
Examples
Copy 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
Return type
GroupShare
Authorization
Basic Authentication, Token Authentication
Content-Type : Not defined
umGroupsSharesGet
umGroupsSharesGet(groupId, opts)
List group shares
List all shares and share privileges for the specified group.
Examples
Copy 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
Return type
GroupShares
Authorization
Basic Authentication, Token Authentication
Content-Type : Not defined
umGroupsSharesPost
umGroupsSharesPost(groupId, resourceId, resource, opts)
Add group shares
Add the specified share to the group.
Examples
Copy 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);
// Add group shares
api_instance
.umGroupsSharesPost ({
groupId : groupId_example ,
resourceId : resourceId_example ,
resource : resource_example ,
pretty : true ,
depth : 56 ,
xContractNumber : 56 ,
options : {}
})
.then ((response) => console .log ( response .data))
.catch ((error) => console .log ( error . response .data));
Parameters
Return type
GroupShare
Authorization
Basic Authentication, Token Authentication
Content-Type : Not defined
umGroupsSharesPut
umGroupsSharesPut(groupId, resourceId, resource, opts)
Modify group share privileges
Modify share permissions for the specified group. With an empty body, no updates are performed, and the current share permissions for the group are returned with response code 200.
Examples
Copy 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 group share privileges
api_instance
.umGroupsSharesPut ({
groupId : groupId_example ,
resourceId : resourceId_example ,
resource : resource_example ,
pretty : true ,
depth : 56 ,
xContractNumber : 56 ,
options : {}
})
.then ((response) => console .log ( response .data))
.catch ((error) => console .log ( error . response .data));
Parameters
Return type
GroupShare
Authorization
Basic Authentication, Token Authentication
Content-Type : application/json
umGroupsUsersDelete
umGroupsUsersDelete(groupId, userId, opts)
Remove users from groups
Remove the specified user from the group.
Examples
Copy 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 users from groups
api_instance
.umGroupsUsersDelete ({
groupId : groupId_example ,
userId : userId_example ,
pretty : true ,
depth : 56 ,
xContractNumber : 56 ,
options : {}
})
.then ((response) => console .log ( response .data))
.catch ((error) => console .log ( error . response .data));
Parameters
Return type
nil (empty response body)
Authorization
Basic Authentication, Token Authentication
Content-Type : Not defined
umGroupsUsersGet
umGroupsUsersGet(groupId, opts)
List group members
List all members of the specified user group.
Examples
Copy 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 members
api_instance
.umGroupsUsersGet ({
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
Return type
GroupMembers
Authorization
Basic Authentication, Token Authentication
Content-Type : Not defined
umGroupsUsersPost
umGroupsUsersPost(groupId, user, opts)
Add a Group Member
Adds an existing user to the specified group.
Examples
Copy 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);
// Add a Group Member
api_instance
.umGroupsUsersPost ({
groupId : groupId_example ,
user : user_example ,
pretty : true ,
depth : 56 ,
xContractNumber : 56 ,
options : {}
})
.then ((response) => console .log ( response .data))
.catch ((error) => console .log ( error . response .data));
Parameters
Return type
User
Authorization
Basic Authentication, Token Authentication
Content-Type : application/json
umResourcesFindByType
umResourcesFindByType(resourceType, opts)
List resources by type
List all resources of the specified type. Resource types are: {datacenter, snapshot, image, ipblock, pcc, backupunit, k8s} Resource types are in the list of resources, returned by GET.
Examples
Copy 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);
// List resources by type
api_instance
.umResourcesFindByType ({
resourceType : resourceType_example ,
pretty : true ,
depth : 56 ,
xContractNumber : 56 ,
options : {}
})
.then ((response) => console .log ( response .data))
.catch ((error) => console .log ( error . response .data));
Parameters
Return type
Resources
Authorization
Basic Authentication, Token Authentication
Content-Type : Not defined
umResourcesFindByTypeAndId
umResourcesFindByTypeAndId(resourceType, resourceId, opts)
Retrieve resources by type
Retrieve a resource by the resource type and resource ID. Resource types are: {datacenter, snapshot, image, ipblock, pcc, backupunit, k8s} Resource types are in the list of resources, returned by GET.
Examples
Copy 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 resources by type
api_instance
.umResourcesFindByTypeAndId ({
resourceType : resourceType_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
Return type
Resource
Authorization
Basic Authentication, Token Authentication
Content-Type : Not defined
umResourcesGet
umResourcesGet(opts)
List all resources
List all the available resources.
Examples
Copy 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 resources
api_instance
.umResourcesGet ({
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
Return type
Resources
Authorization
Basic Authentication, Token Authentication
Content-Type : Not defined
umUsersDelete
umUsersDelete(userId, opts)
Delete users
Delete the specified user.
Examples
Copy 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 users
api_instance
.umUsersDelete ({
userId : userId_example ,
pretty : true ,
depth : 56 ,
xContractNumber : 56 ,
options : {}
})
.then ((response) => console .log ( response .data))
.catch ((error) => console .log ( error . response .data));
Parameters
Return type
nil (empty response body)
Authorization
Basic Authentication, Token Authentication
Content-Type : Not defined
umUsersFindById
umUsersFindById(userId, opts)
Retrieve users
Retrieve user properties by user ID. The user ID is in the response body when the user is created, and in the list of the users, returned by GET.
Examples
Copy 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 users
api_instance
.umUsersFindById ({
userId : userId_example ,
pretty : true ,
depth : 56 ,
xContractNumber : 56 ,
options : {}
})
.then ((response) => console .log ( response .data))
.catch ((error) => console .log ( error . response .data));
Parameters
Return type
User
Authorization
Basic Authentication, Token Authentication
Content-Type : Not defined
umUsersGet
umUsersGet(opts)
List all users
List all the users in your account.
Examples
Copy 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 users
api_instance
.umUsersGet ({
pretty : true ,
depth : 56 ,
xContractNumber : 56 ,
offset : 56 ,
limit : 56
orderBy: "<property_name>"
maxResults: 2 ,
filters : filterMap
options: {}
})
.then ((response) => console .log ( response .data))
.catch ((error) => console .log ( error . response .data));
Parameters
Return type
Users
Authorization
Basic Authentication, Token Authentication
Content-Type : Not defined
umUsersGroupsGet
umUsersGroupsGet(userId, opts)
Retrieve group resources by user ID
Retrieve group resources of the user by user ID. The user ID is in the response body when the user is created, and in the list of the users, returned by GET.
Examples
Copy 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 by user ID
api_instance
.umUsersGroupsGet ({
userId : userId_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
Return type
ResourceGroups
Authorization
Basic Authentication, Token Authentication
Content-Type : Not defined
umUsersOwnsGet
umUsersOwnsGet(userId, opts)
Retrieve user resources by user ID
Retrieve own resources of the user by user ID. The user ID is in the response body when the user is created, and in the list of the users, returned by GET.
Examples
Copy 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 user resources by user ID
api_instance
.umUsersOwnsGet ({
userId : userId_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
Return type
ResourcesUsers
Authorization
Basic Authentication, Token Authentication
Content-Type : Not defined
umUsersPost
umUsersPost(user, opts)
Create users
Create a user.
Examples
Copy 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 users
api_instance
.umUsersPost ({
user : user_example ,
pretty : true ,
depth : 56 ,
xContractNumber : 56 ,
options : {}
})
.then ((response) => console .log ( response .data))
.catch ((error) => console .log ( error . response .data));
Parameters
Return type
User
Authorization
Basic Authentication, Token Authentication
Content-Type : application/json
umUsersPut
umUsersPut(userId, user, opts)
Modify users
Modify the properties of the specified user.
Examples
Copy 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 users
api_instance
.umUsersPut ({
userId : userId_example ,
user : user_example ,
pretty : true ,
depth : 56 ,
xContractNumber : 56 ,
options : {}
})
.then ((response) => console .log ( response .data))
.catch ((error) => console .log ( error . response .data));
Parameters
Return type
User
Authorization
Basic Authentication, Token Authentication
Content-Type : application/json