Obtaining User Email Information
Function
This API is used to obtain user email information.
Debugging
You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.
URI
GET https://{hostURL}/v4/user/emails
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| X-Auth-Token | Yes | String | Definition User token. Obtain a token by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token. Constraints Mandatory. Range 1–100,000 characters. Default Value N/A. |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| id | Integer | Definition User ID. Value range: 1~2147483647 |
| name | String | Definition Username. Range 1–1,000 characters. |
| username | String | Definition Long user ID. Range 1–1,000 characters. |
| state | String | Definition: User status. active: active user; blocked: locked user Default value: active Enumeration values: |
| created_at | String | Definition Creation time. Range 1–1,000 characters. |
| updated_at | String | Definition Update time. Range 1–1,000 characters. |
| last_activity_on | String | Definition Last active time. Range 1–1,000 characters. |
| commit_email | String | Definition Commit email. Range 1–1,000 characters. |
Status code: 401
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Definition Error code. |
| error_msg | String | Definition Error message. |
Status code: 403
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Definition Error code. |
| error_msg | String | Definition Error message. |
Example Requests
GET https://{endpoint}/v4/user/emails Example Responses
Status code: 200
Obtain user email information.
{
"id" : 21820,
"name" : "tr8",
"username" : "ac105e52a4764a4c8f29b306508f016d",
"state" : "active",
"created_at" : "2025-03-27T14:17:11.000+08:00",
"updated_at" : "2025-05-20T15:42:31.351+08:00",
"last_activity_on" : "2025-05-17",
"commit_email" : "1@email.com"
} Status code: 401
Unauthorized
{
"error_code" : "DEV.00000003",
"error_msg" : "Authentication information expired."
} Status code: 403
Bad Request
{
"error_code" : "CH.004403",
"error_msg" : "Insufficient permissions. Apply for the required permissions and try again."
} Status Codes
| Status Code | Description |
|---|---|
| 200 | Obtain user email information. |
| 401 | Unauthorized |
| 403 | Bad Request |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
