--- title: Récupérer des utilisateurs slug: recuperer-des-utilisateurs docTags: createdAt: 2026-06-04T15:50:56.155Z --- { "id": "Otq0rcInlaVk_XTGLrRCF", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://api.ionos.com/cloudapi/v6/um/users/{userId}", "servers": [ { "url": "https://api.ionos.com/cloudapi/v6/um/users/{userId}" } ], "name": "Retrieve users", "description": "

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.

", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "userId", "type": "string", "description": "The unique ID of the user." } ], "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": "User", "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": "", "format": "uri" }, { "name": "metadata", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/UserMetadata", "customType": "UserMetadata", "schema": [ { "name": "etag", "kind": "optional", "type": "string", "readOnly": true, "description": "

Resource's Entity Tag as defined in http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.11 Entity Tag is also added as an 'ETag response header to requests which don't use 'depth' parameter.

", "example": "45480eb3fbfc31f1d916c1eaa4abdcc3" }, { "name": "createdDate", "kind": "optional", "type": "string", "readOnly": true, "description": "The time the user was created.", "example": "2015-12-04T14:34:09.809Z", "format": "date-time" }, { "name": "createdBy", "kind": "optional", "type": "string", "readOnly": true, "description": "The user who has created the resource.", "example": "user@example.com" }, { "name": "createdByUserId", "kind": "optional", "type": "string", "readOnly": true, "description": "The unique ID of the user who created the resource.", "example": "63cef532-26fe-4a64-a4e0-de7c8a506c90" }, { "name": "lastModifiedDate", "kind": "optional", "type": "string", "readOnly": true, "description": "The last time the resource was modified.", "example": "2015-12-04T14:34:09.809Z", "format": "date-time" }, { "name": "lastModifiedBy", "kind": "optional", "type": "string", "readOnly": true, "description": "The user who last modified the resource.", "example": "user@example.com" }, { "name": "lastModifiedByUserId", "kind": "optional", "type": "string", "readOnly": true, "description": "The unique ID of the user who last modified the resource.", "example": "63cef532-26fe-4a64-a4e0-de7c8a506c90" }, { "name": "lastLogin", "kind": "optional", "type": "string", "readOnly": true, "description": "The time of the last login by the user.", "example": "2015-12-04T14:34:09.809Z", "format": "date-time" } ] }, { "name": "properties", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/UserProperties", "customType": "UserProperties", "schema": [ { "name": "firstname", "kind": "optional", "type": "string", "description": "The first name of the user." }, { "name": "lastname", "kind": "optional", "type": "string", "description": "The last name of the user." }, { "name": "email", "kind": "optional", "type": "string", "description": "The email address of the user." }, { "name": "administrator", "kind": "optional", "type": "boolean", "description": "Indicates if the user has admin rights." }, { "name": "forceSecAuth", "kind": "optional", "type": "boolean", "description": "Indicates if secure authentication should be forced on the user." }, { "name": "secAuthActive", "kind": "optional", "type": "boolean", "description": "Indicates if secure authentication is active for the user." }, { "name": "s3CanonicalUserId", "kind": "optional", "type": "string", "description": "

Canonical (Object storage) ID of the user for a given identity.

" }, { "name": "active", "kind": "optional", "type": "boolean", "description": "Indicates if the user is active." } ] }, { "name": "entities", "kind": "optional", "type": "object", "description": "Collection of entity references associated with a user.", "modelRef": "#/components/schemas/UsersEntities", "customType": "UsersEntities", "schema": [ { "name": "owns", "kind": "optional", "type": "object", "description": "

Reference to resources owned by a user (without nested items).

", "modelRef": "#/components/schemas/ResourcesUsersRef", "customType": "ResourcesUsersRef", "schema": [ { "name": "id", "kind": "optional", "type": "string", "readOnly": true, "description": "The resource's unique identifier.", "example": "15f67991-0f51-4efc-a8ad-ef1fb31a480c/owns" }, { "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/users/9b1b4c62-1466-11e7-87d3-d7bb7dac0087/owns", "format": "uri" } ] }, { "name": "groups", "kind": "optional", "type": "object", "description": "

Reference to groups a user belongs to (without nested items).

", "modelRef": "#/components/schemas/GroupUsersRef", "customType": "GroupUsersRef", "schema": [ { "name": "id", "kind": "optional", "type": "string", "readOnly": true, "description": "The resource's unique identifier.", "example": "15f67991-0f51-4efc-a8ad-ef1fb31a480c/groups" }, { "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/users/9b1b4c62-1466-11e7-87d3-d7bb7dac0087/groups", "format": "uri" } ] }, { "name": "s3Keys", "kind": "optional", "type": "object", "description": "

Reference to S3 keys associated with a user (without nested items).

", "modelRef": "#/components/schemas/S3KeysRef", "customType": "S3KeysRef", "schema": [ { "name": "id", "kind": "optional", "type": "string", "readOnly": true, "description": "The resource's unique identifier.", "example": "15f67991-0f51-4efc-a8ad-ef1fb31a480c/s3keys" }, { "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/users/9b1b4c62-1466-11e7-87d3-d7bb7dac0087/s3keys", "format": "uri" } ] } ] } ], "modelRef": "#/components/schemas/User", "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": "M5NNjrA7DI6f20qZFGYmW", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url 'https://api.ionos.com/cloudapi/v6/um/users/{userId}?pretty=true&depth=integer%3Cint32%3E' \\\n --header 'accept: application/json'" }, { "id": "8LNrR6k80LvzAWtvr7iVl", "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/users/{userId}?pretty=true&depth=integer\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "vvmVYHrEY-RDU_SV0UFS-", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.ionos.com/cloudapi/v6/um/users/{userId}?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": "zzXfkS4JpJhhhrzmXsD6d", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.ionos.com/cloudapi/v6/um/users/{userId}?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": "M5NNjrA7DI6f20qZFGYmW" }, "results": { "languages": [ { "id": "IeELN2wKB9YAYjyrQmT0o", "language": "200", "code": "// Successful operation\n{\n \"id\": \"15f67991-0f51-4efc-a8ad-ef1fb31a480c\",\n \"type\": {},\n \"href\": \"\",\n \"metadata\": {\n \"etag\": \"45480eb3fbfc31f1d916c1eaa4abdcc3\",\n \"createdDate\": \"2015-12-04T14:34:09.809Z\",\n \"createdBy\": \"user@example.com\",\n \"createdByUserId\": \"63cef532-26fe-4a64-a4e0-de7c8a506c90\",\n \"lastModifiedDate\": \"2015-12-04T14:34:09.809Z\",\n \"lastModifiedBy\": \"user@example.com\",\n \"lastModifiedByUserId\": \"63cef532-26fe-4a64-a4e0-de7c8a506c90\",\n \"lastLogin\": \"2015-12-04T14:34:09.809Z\"\n },\n \"properties\": {\n \"firstname\": \"\",\n \"lastname\": \"\",\n \"email\": \"\",\n \"administrator\": false,\n \"forceSecAuth\": false,\n \"secAuthActive\": false,\n \"s3CanonicalUserId\": \"\",\n \"active\": false\n },\n \"entities\": {\n \"owns\": {\n \"id\": \"15f67991-0f51-4efc-a8ad-ef1fb31a480c/owns\",\n \"type\": {},\n \"href\": \"https:///cloudapi/v6/um/users/9b1b4c62-1466-11e7-87d3-d7bb7dac0087/owns\"\n },\n \"groups\": {\n \"id\": \"15f67991-0f51-4efc-a8ad-ef1fb31a480c/groups\",\n \"type\": {},\n \"href\": \"https:///cloudapi/v6/um/users/9b1b4c62-1466-11e7-87d3-d7bb7dac0087/groups\"\n },\n \"s3Keys\": {\n \"id\": \"15f67991-0f51-4efc-a8ad-ef1fb31a480c/s3keys\",\n \"type\": {},\n \"href\": \"https:///cloudapi/v6/um/users/9b1b4c62-1466-11e7-87d3-d7bb7dac0087/s3keys\"\n }\n }\n}" }, { "id": "UdmgGVUyvh4FGayThJuG1", "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": "IeELN2wKB9YAYjyrQmT0o" } }, "children": [ { "text": "", "id": "PB8jrW5IpImFbnra4g6Jx" } ] }