List Users¶
List the information of internal users, LDAP users, and SSO users of the OU, including the users’ recent login times.
Request Parameters (URI)¶
Name | Location (Path/Query) | Required/Optional | Data Type | Description |
---|---|---|---|---|
orgId | Query | Required | String | The ID of the OU to which the user belongs to. How to get orgId>> |
fromTime | Query | Optional | String | The starting time of the recent login time range for the user in the format YYYY-MM-DD HH:mm:ss . |
toTime | Query | Optional | String | The end time of the recent login time range for the user in the format YYYY-MM-DD HH:mm:ss . |
Response Parameters¶
Name | Data Type | Description |
---|---|---|
userWithLoginTime | Array of User Struct | The list of users. For more information, see User Struct. |
User Struct ¶
Name | Data Type | Description |
---|---|---|
id | String | The user ID. |
name | String | The name of the user. |
String | The email of the user. | |
emailVerified | Boolean | Whether the email is verified. |
phoneArea | String | The country code of the user’s mobile phone number. |
phone | String | The mobile number of the user. |
phoneVerified | Boolean | Whether the mobile number is verified. |
organizationId | String | The OU that the user belongs to. |
state | Integer | The state of the account.
|
domain | String | The configured SSO identity provider name. Supports SSO users only. |
authType | Integer | The user type. |
createTime | String | The time the user was created.
|
description | String | The description of the user. |
passwordExpireTime | Long | The time the password will expire. This parameter is fixed at 0 for SSO users. |
lastLoginTime | String | The last login time of the user. |
updateTime | String | The last updated time of the user information. |
Samples¶
Request Sample¶
url: https://{apigw-address}/enos-iam-service/v2.4/open/user/logintime/list?orgId=yourOrgId
method: GET
Return Sample¶
{
"fail": false,
"userWithLoginTime": [
{
"id": "u16xxxxxxxxxxxxxx7",
"name": "xxxxxx",
"email": "xxxx@enos.com",
"phone": "",
"state": 0,
"domain": "",
"authType": 0,
"phoneArea": "",
"createTime": "2022-02-25 09:48:59",
"updateTime": "2022-10-10 03:20:33",
"description": "",
"emailVerified": true,
"lastLoginTime": "2023-12-01 09:51:56",
"phoneVerified": false,
"organizationId": "o16xxxxxxxxxxx",
"passwordExpireTime": 0
}
],
"success": true,
"failed": false,
"message": "",
"status": 0,
"successful": true
}