Responses

Status Code

A status code is a group of digits ranging from 1xx to 5xx. It indicates the status of a request. For more information, see Status Code.

If status code 201 is returned for the API for creating an IAM user as the administrator, the request is successful.

Response Header

Similar to a request, a response also has a header, for example, Content-Type.

Figure 1 shows the response header for the API for creating an IAM user as the administrator.

Figure 1 Response header for the API for creating an IAM user as the administrator

Response Body

A response body is generally returned in a structured format as specified in Content-type in the response header. The response body transfers content except the response header.

For the API for creating an IAM user as the administrator, the following message body is returned. The following is part of the response body for the API for obtaining a user token.

{
    "user": {
        "id": "c131886aec...",
        "name": "IAMUser",
        "description": "IAM User Description",
        "areacode": "",
        "phone": "",
        "email": "***@***.com",
        "status": null,
        "enabled": true,
        "pwd_status": false,
        "access_mode": "default",
        "is_domain_owner": false,
        "xuser_id": "",
        "xuser_type": "",
        "password_expires_at": null,
        "create_time": "2024-05-21T09:03:41.000000",
        "domain_id": "d78cbac1..........",
        "xdomain_id": "30086000........",
        "xdomain_type": "",
        "default_project_id": null
    }
}

If an error occurs during API calling, an error code and the corresponding error message will be displayed. The following shows an error response body:

{
    "error_msg": "Request body is invalid.",
    "error_code": "IAM.0011"
}

In the response body, error_code is an error code, and error_msg provides information about the error.