--- title: Lister tous les groupes slug: lister-tous-les-groupes docTags: createdAt: 2026-06-04T15:50:56.155Z --- { "id": "ADG7R5FF6xkXwF76omMrG", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://api.ionos.com/cloudapi/v6/um/groups", "servers": [ { "url": "https://api.ionos.com/cloudapi/v6/um/groups" } ], "name": "List all groups", "description": "List all the available user groups.", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" }, { "kind": "optional", "name": "X-Contract-Number", "type": "integer", "description": "

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

", "format": "int32" } ], "queryParameters": [ { "kind": "optional", "name": "pretty", "type": "boolean", "description": "

Controls whether the response is pretty-printed (with indentations and new lines).

", "default": true }, { "kind": "optional", "name": "depth", "type": "integer", "description": "

Controls the detail depth of the response objects. NOTE: The resource /um and its children support a maximum depth level of 1. It will provide you the entry points to specific user related resources. As these resources are partially servered by other service components, they must be retrieved explicitly. Any depth parameter beyond '?depth=1' will be deprecated by April 30, 2026.

", "default": 0, "format": "int32", "minimum": 0, "maximum": 1 } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "BasicAuthentication", "name": "BasicAuthentication", "kind": "optional", "type": "http", "description": "

You will need to base64 encode the string containing your credentials. \nNote:\n\n

", "scheme": "basic" }, { "id": "TokenAuthentication", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Please provide header value as 'Bearer ' and don't forget to add 'Bearer' HTTP Authorization Scheme before the token.

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Successful operation", "jsonExample": "", "isExpanded": true, "headers": [ { "kind": "optional", "name": "X-RateLimit-Remaining", "type": "integer", "description": "The number of requests that can still be made without triggering a failure response.", "format": "int32" }, { "kind": "optional", "name": "X-RateLimit-Limit", "type": "integer", "description": "The average number of requests per minute allowed.", "format": "int32" }, { "kind": "optional", "name": "X-RateLimit-Burst", "type": "integer", "description": "The maximum number of concurrent API requests allowed.", "format": "int32" } ], "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "Groups", "schema": [ { "name": "id", "kind": "optional", "type": "string", "readOnly": true, "description": "The resource's unique identifier.", "example": "15f67991-0f51-4efc-a8ad-ef1fb31a480c" }, { "name": "type", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Type", "description": "", "modelRef": "#/components/schemas/Type", "schema": [] } ], "schema": [] }, { "name": "href", "kind": "optional", "type": "string", "readOnly": true, "description": "

URL to the object representation (absolute path).

", "example": "https:///cloudapi/v6/um/groups", "format": "uri" }, { "name": "items", "kind": "optional", "type": "array", "readOnly": true, "description": "Array of items in the collection.", "modelRef": "#/components/schemas/Group", "customType": "Group[]", "schema": [ { "name": "id", "kind": "optional", "type": "string", "readOnly": true, "description": "The resource's unique identifier.", "example": "15f67991-0f51-4efc-a8ad-ef1fb31a480c" }, { "name": "type", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Type", "description": "", "modelRef": "#/components/schemas/Type", "schema": [] } ], "schema": [] }, { "name": "href", "kind": "optional", "type": "string", "readOnly": true, "description": "

URL to the object representation (absolute path).

", "example": "https:///cloudapi/v6/um/groups/15f67991-0f51-4efc-a8ad-ef1fb31a480c", "format": "uri" }, { "name": "properties", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/GroupProperties", "customType": "GroupProperties", "schema": [ { "name": "name", "kind": "optional", "type": "string", "description": "The name of the resource.", "example": "My resource" }, { "name": "createDatacenter", "kind": "optional", "type": "boolean", "description": "Create data center privilege." }, { "name": "createSnapshot", "kind": "optional", "type": "boolean", "description": "Create snapshot privilege." }, { "name": "reserveIp", "kind": "optional", "type": "boolean", "description": "Reserve IP block privilege." }, { "name": "accessActivityLog", "kind": "optional", "type": "boolean", "description": "Activity log access privilege." }, { "name": "createPcc", "kind": "optional", "type": "boolean", "description": "User privilege to create a cross connect." }, { "name": "s3Privilege", "kind": "optional", "type": "boolean", "description": "S3 privilege." }, { "name": "createBackupUnit", "kind": "optional", "type": "boolean", "description": "Create backup unit privilege." }, { "name": "createInternetAccess", "kind": "optional", "type": "boolean", "description": "Create internet access privilege." }, { "name": "createK8sCluster", "kind": "optional", "type": "boolean", "description": "Create Kubernetes cluster privilege." }, { "name": "createFlowLog", "kind": "optional", "type": "boolean", "description": "Create Flow Logs privilege." }, { "name": "accessAndManageMonitoring", "kind": "optional", "type": "boolean", "description": "

Privilege for a group to access and manage monitoring related functionality (access metrics, CRUD on alarms, alarm-actions etc) using Monotoring-as-a-Service (MaaS).

" }, { "name": "accessAndManageCertificates", "kind": "optional", "type": "boolean", "description": "Privilege for a group to access and manage certificates." }, { "name": "manageDBaaS", "kind": "optional", "type": "boolean", "description": "Privilege for a group to manage DBaaS related functionality." }, { "name": "accessAndManageDns", "kind": "optional", "type": "boolean", "description": "Privilege for a group to access and manage dns records." }, { "name": "manageRegistry", "kind": "optional", "type": "boolean", "description": "Privilege for group accessing container registry related functionality." }, { "name": "manageDataplatform", "kind": "optional", "type": "boolean", "description": "Privilege for a group to access and manage the Data Platform." }, { "name": "accessAndManageLogging", "kind": "optional", "type": "boolean", "description": "Privilege for a group to access and manage Logs." }, { "name": "accessAndManageCdn", "kind": "optional", "type": "boolean", "description": "Privilege for a group to access and manage CDN." }, { "name": "accessAndManageVpn", "kind": "optional", "type": "boolean", "description": "Privilege for a group to access and manage VPN." }, { "name": "accessAndManageApiGateway", "kind": "optional", "type": "boolean", "description": "Privilege for a group to access and manage API Gateway." }, { "name": "accessAndManageKaas", "kind": "optional", "type": "boolean", "description": "Privilege for a group to access and manage KaaS." }, { "name": "accessAndManageNetworkFileStorage", "kind": "optional", "type": "boolean", "description": "Privilege for a group to access and manage Network File Storage." }, { "name": "accessAndManageAiModelHub", "kind": "optional", "type": "boolean", "description": "Privilege for a group to access and manage AI Model Hub." }, { "name": "accessAndManageIamResources", "kind": "optional", "type": "boolean", "description": "Privilege for a group to access and manage Password Policies." }, { "name": "createNetworkSecurityGroups", "kind": "optional", "type": "boolean", "description": "Privilege for a group to access and manage Network Security Groups." } ] }, { "name": "entities", "kind": "optional", "type": "object", "description": "Collection of entity references associated with a group.", "modelRef": "#/components/schemas/GroupEntities", "customType": "GroupEntities", "schema": [ { "name": "users", "kind": "optional", "type": "object", "description": "

Reference to group members (without nested items).

", "modelRef": "#/components/schemas/GroupMembersRef", "customType": "GroupMembersRef", "schema": [ { "name": "id", "kind": "optional", "type": "string", "readOnly": true, "description": "The resource's unique identifier.", "example": "15f67991-0f51-4efc-a8ad-ef1fb31a480c/users" }, { "name": "type", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Type", "description": "", "modelRef": "#/components/schemas/Type", "schema": [] } ], "schema": [] }, { "name": "href", "kind": "optional", "type": "string", "readOnly": true, "description": "

URL to the object representation (absolute path).

", "example": "https:///cloudapi/v6/um/groups/30740c22-1def-11e7-aac9-d7a3646ca7fd/users", "format": "uri" } ] }, { "name": "resources", "kind": "optional", "type": "object", "description": "

Reference to resources assigned to a group (without nested items).

", "modelRef": "#/components/schemas/ResourceGroupsRef", "customType": "ResourceGroupsRef", "schema": [ { "name": "id", "kind": "optional", "type": "string", "readOnly": true, "description": "The resource's unique identifier.", "example": "15f67991-0f51-4efc-a8ad-ef1fb31a480c/resources" }, { "name": "type", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Type", "description": "", "modelRef": "#/components/schemas/Type", "schema": [] } ], "schema": [] }, { "name": "href", "kind": "optional", "type": "string", "readOnly": true, "description": "

URL to the object representation (absolute path).

", "example": "https:///cloudapi/v6/um/groups/30740c22-1def-11e7-aac9-d7a3646ca7fd/resources", "format": "uri" } ] } ] } ] } ], "modelRef": "#/components/schemas/Groups", "isExpanded": true } ] }, { "statusCode": "default", "description": "

Any erroneous status code: 400 (parse error), 401 (auth error), 402 (trial access), 403 (insufficient privileges), 404 (not found), 405 (unsupported HTTP method), 415 (unsupported content type, 422 (validation error), 429 (request rate limit exceeded), 500 (server error), or 503 (maintenance).

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "Error", "schema": [ { "name": "httpStatus", "kind": "optional", "type": "integer", "readOnly": true, "description": "HTTP status code of the operation.", "example": 400, "format": "int32" }, { "name": "messages", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/ErrorMessage", "customType": "ErrorMessage[]", "schema": [ { "name": "errorCode", "kind": "optional", "type": "string", "readOnly": true, "description": "Application internal error code.", "example": "123" }, { "name": "message", "kind": "optional", "type": "string", "readOnly": true, "description": "

A human-readable message.

", "example": "Error message example." } ] } ], "modelRef": "#/components/schemas/Error", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "2Xcb70krDcHDGolAMBjwf", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url 'https://api.ionos.com/cloudapi/v6/um/groups?pretty=true&depth=integer%3Cint32%3E' \\\n --header 'accept: application/json'" }, { "id": "wxL6nRnyHeZl2bPWYUfdu", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api.ionos.com/cloudapi/v6/um/groups?pretty=true&depth=integer\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "YKnmg2Yef0rUOWBTt75J1", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.ionos.com/cloudapi/v6/um/groups?pretty=true&depth=integer\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "FNnsBOHJPUxVgFur2-Y8t", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.ionos.com/cloudapi/v6/um/groups?pretty=true&depth=integer\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "2Xcb70krDcHDGolAMBjwf" }, "results": { "languages": [ { "id": "oAp5CdwsGkoY8xbcEBgu1", "language": "200", "code": "// Successful operation\n{\n \"id\": \"15f67991-0f51-4efc-a8ad-ef1fb31a480c\",\n \"type\": {},\n \"href\": \"https:///cloudapi/v6/um/groups\",\n \"items\": [\n {\n \"id\": \"15f67991-0f51-4efc-a8ad-ef1fb31a480c\",\n \"type\": {},\n \"href\": \"https:///cloudapi/v6/um/groups/15f67991-0f51-4efc-a8ad-ef1fb31a480c\",\n \"properties\": {\n \"name\": \"My resource\",\n \"createDatacenter\": false,\n \"createSnapshot\": false,\n \"reserveIp\": false,\n \"accessActivityLog\": false,\n \"createPcc\": false,\n \"s3Privilege\": false,\n \"createBackupUnit\": false,\n \"createInternetAccess\": false,\n \"createK8sCluster\": false,\n \"createFlowLog\": false,\n \"accessAndManageMonitoring\": false,\n \"accessAndManageCertificates\": false,\n \"manageDBaaS\": false,\n \"accessAndManageDns\": false,\n \"manageRegistry\": false,\n \"manageDataplatform\": false,\n \"accessAndManageLogging\": false,\n \"accessAndManageCdn\": false,\n \"accessAndManageVpn\": false,\n \"accessAndManageApiGateway\": false,\n \"accessAndManageKaas\": false,\n \"accessAndManageNetworkFileStorage\": false,\n \"accessAndManageAiModelHub\": false,\n \"accessAndManageIamResources\": false,\n \"createNetworkSecurityGroups\": false\n },\n \"entities\": {\n \"users\": {\n \"id\": \"15f67991-0f51-4efc-a8ad-ef1fb31a480c/users\",\n \"type\": {},\n \"href\": \"https:///cloudapi/v6/um/groups/30740c22-1def-11e7-aac9-d7a3646ca7fd/users\"\n },\n \"resources\": {\n \"id\": \"15f67991-0f51-4efc-a8ad-ef1fb31a480c/resources\",\n \"type\": {},\n \"href\": \"https:///cloudapi/v6/um/groups/30740c22-1def-11e7-aac9-d7a3646ca7fd/resources\"\n }\n }\n }\n ]\n}" }, { "id": "pXxXYo45naBhahzp1-TBq", "language": "default", "code": "// Any erroneous status code: 400 (parse error), 401 (auth error), 402 (trial access), 403 (insufficient privileges), 404 (not found), 405 (unsupported HTTP method), 415 (unsupported content type, 422 (validation error), 429 (request rate limit exceeded), 500 (server error), or 503 (maintenance).\n{\n \"httpStatus\": 400,\n \"messages\": [\n {\n \"errorCode\": \"123\",\n \"message\": \"Error message example.\"\n }\n ]\n}" } ], "selectedLanguageId": "oAp5CdwsGkoY8xbcEBgu1" } }, "children": [ { "text": "", "id": "ykk_DqBAo2G1bkt4-BRNc" } ] }