UserManagementApi
All URIs are relative to https://api.ionos.com/cloudapi/v5
Method | HTTP request | Description |
---|---|---|
DELETE /um/groups/{groupId} | Delete a Group | |
GET /um/groups/{groupId} | Retrieve a Group | |
GET /um/groups | List All Groups. | |
POST /um/groups | Create a Group | |
PUT /um/groups/{groupId} | Modify a group | |
GET /um/groups/{groupId}/resources | Retrieve resources assigned to a group | |
DELETE /um/groups/{groupId}/shares/{resourceId} | Remove a resource from a group | |
GET /um/groups/{groupId}/shares/{resourceId} | Retrieve a group share | |
GET /um/groups/{groupId}/shares | List Group Shares | |
POST /um/groups/{groupId}/shares/{resourceId} | Add a resource to a group | |
PUT /um/groups/{groupId}/shares/{resourceId} | Modify resource permissions of a group | |
DELETE /um/groups/{groupId}/users/{userId} | Remove a user from a group | |
GET /um/groups/{groupId}/users | List Group Members | |
POST /um/groups/{groupId}/users | Add a user to a group | |
GET /um/resources/{resourceType} | Retrieve a list of Resources by type. | |
GET /um/resources/{resourceType}/{resourceId} | Retrieve a Resource by type. | |
GET /um/resources | List All Resources. | |
DELETE /um/users/{userId} | Delete a User | |
GET /um/users/{userId} | Retrieve a User | |
GET /um/users | List all Users | |
GET /um/users/{userId}/groups | Retrieve a User's group resources | |
GET /um/users/{userId}/owns | Retrieve a User's own resources | |
POST /um/users | Create a user | |
PUT /um/users/{userId} | Modify a user | |
DELETE /um/users/{userId}/s3keys/{keyId} | Delete a S3 key | |
GET /um/users/{userId}/s3keys/{keyId} | Retrieve given S3 key belonging to the given User | |
GET /um/users/{userId}/s3keys | Retrieve a User's S3 keys | |
POST /um/users/{userId}/s3keys | Create a S3 key for the given user | |
PUT /um/users/{userId}/s3keys/{keyId} | Modify a S3 key having the given key id | |
GET /um/users/{userId}/s3ssourl | Retrieve S3 object storage single signon URL for the given user |
um_groups_delete
Object um_groups_delete(group_id, opts)
Delete a Group
Delete a group
Examples
Using the um_groups_delete_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(Object, Integer, Hash)> um_groups_delete_with_http_info(group_id, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
group_id | String | The unique ID of the group | |
pretty | Boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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] |
x_contract_number | Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
Return type
Object
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
um_groups_find_by_id
um_groups_find_by_id(group_id, opts)
Retrieve a Group
You can retrieve a group by using the group ID. This value can be found in the response body when a group is created or when you GET a list of groups.
Examples
Using the um_groups_find_by_id_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> um_groups_find_by_id_with_http_info(group_id, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
group_id | String | The unique ID of the group | |
pretty | Boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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] |
x_contract_number | Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
um_groups_get
um_groups_get(opts)
List All Groups.
You can retrieve a complete list of all groups that you have access to
Examples
Using the um_groups_get_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> um_groups_get_with_http_info(opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
pretty | Boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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] |
x_contract_number | Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
um_groups_post
um_groups_post(group, opts)
Create a Group
You can use this POST method to create a group
Examples
Using the um_groups_post_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> um_groups_post_with_http_info(group, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
group | Group to be created | ||
pretty | Boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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] |
x_contract_number | Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: application/json
Accept: application/json
um_groups_put
um_groups_put(group_id, group, opts)
Modify a group
You can use this method to update properties of the group.
Examples
Using the um_groups_put_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> um_groups_put_with_http_info(group_id, group, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
group_id | String | The unique ID of the group | |
group | Modified properties of the Group | ||
pretty | Boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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] |
x_contract_number | Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: application/json
Accept: application/json
um_groups_resources_get
um_groups_resources_get(group_id, opts)
Retrieve resources assigned to a group
Examples
Using the um_groups_resources_get_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> um_groups_resources_get_with_http_info(group_id, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
group_id | String | The unique ID of the group | |
pretty | Boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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] |
x_contract_number | Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
um_groups_shares_delete
Object um_groups_shares_delete(group_id, resource_id, opts)
Remove a resource from a group
This will remove a resource from a group
Examples
Using the um_groups_shares_delete_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(Object, Integer, Hash)> um_groups_shares_delete_with_http_info(group_id, resource_id, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
group_id | String | ||
resource_id | String | ||
pretty | Boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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] |
x_contract_number | Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
Return type
Object
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
um_groups_shares_find_by_resource_id
um_groups_shares_find_by_resource_id(group_id, resource_id, opts)
Retrieve a group share
This will retrieve the properties of a group share.
Examples
Using the um_groups_shares_find_by_resource_id_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> um_groups_shares_find_by_resource_id_with_http_info(group_id, resource_id, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
group_id | String | ||
resource_id | String | ||
pretty | Boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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] |
x_contract_number | Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
um_groups_shares_get
um_groups_shares_get(group_id, opts)
List Group Shares
You can retrieve a list of all resources along with their permissions of the group
Examples
Using the um_groups_shares_get_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> um_groups_shares_get_with_http_info(group_id, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
group_id | String | ||
pretty | Boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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] |
x_contract_number | Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
um_groups_shares_post
um_groups_shares_post(group_id, resource_id, resource, opts)
Add a resource to a group
This will add a resource to the group.
Examples
Using the um_groups_shares_post_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> um_groups_shares_post_with_http_info(group_id, resource_id, resource, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
group_id | String | ||
resource_id | String | ||
resource | Resource to be added | ||
pretty | Boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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] |
x_contract_number | Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
um_groups_shares_put
um_groups_shares_put(group_id, resource_id, resource, opts)
Modify resource permissions of a group
You can use update resource permissions of a group. If empty body will be provided, no updates will happen, instead you will be returned the current permissions of resource in a group. In this case response code will be 200
Examples
Using the um_groups_shares_put_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> um_groups_shares_put_with_http_info(group_id, resource_id, resource, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
group_id | String | ||
resource_id | String | ||
resource | Modified Resource | ||
pretty | Boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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] |
x_contract_number | Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: application/json
Accept: application/json
um_groups_users_delete
Object um_groups_users_delete(group_id, user_id, opts)
Remove a user from a group
This will remove a user from a group
Examples
Using the um_groups_users_delete_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(Object, Integer, Hash)> um_groups_users_delete_with_http_info(group_id, user_id, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
group_id | String | ||
user_id | String | ||
pretty | Boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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] |
x_contract_number | Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
Return type
Object
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
um_groups_users_get
um_groups_users_get(group_id, opts)
List Group Members
You can retrieve a list of users who are members of the group
Examples
Using the um_groups_users_get_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> um_groups_users_get_with_http_info(group_id, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
group_id | String | ||
pretty | Boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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] |
x_contract_number | Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
um_groups_users_post
um_groups_users_post(group_id, user, opts)
Add a user to a group
This will attach a pre-existing user to a group.
Examples
Using the um_groups_users_post_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> um_groups_users_post_with_http_info(group_id, user, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
group_id | String | ||
user | User to be added | ||
pretty | Boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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] |
x_contract_number | Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: application/json
Accept: application/json
um_resources_find_by_type
um_resources_find_by_type(resource_type, opts)
Retrieve a list of Resources by type.
You can retrieve a list of resources by using the type. Allowed values are { datacenter, snapshot, image, ipblock, pcc, backupunit, k8s }. This value of resource type also be found in the response body when you GET a list of all resources.