IDaaS Open Platform
Employee Identity (EIAM)

Query User Operation Logs

API

# Permissions

The Identity Management API is authorized at the application level. Before calling the API, you need to set API permissions for different applications. For details, please refer to API Permissions.

Permission Code Description
operation_log_read Read permission for log audit APIs
all Read and write permissions for all APIs
read Permission for all read APIs

# Request Specification

GET https://{your_domain}/api/v2/tenant/logs/users-log?start_time=2022-04-14 00:00:00&end_time=2022-04-18 23:59:59&offset=0&limit=50

# Request Headers

Parameter Name Chinese Name Required Type Description
Authorization Authorization Yes String Format: Bearer {access_token}
Content-Type Content Type Yes String Fixed value: application/json; charset=utf-8

# Request Example

None

# Request Parameters

Parameter Name Chinese Name Required Type Description
start_time Start Time Yes String yyyy-MM-dd HH:mm:ss
end_time End Time Yes String yyyy-MM-dd HH:mm:ss
offset Page Number Yes Int Starts from page 0
limit Items per page Yes Int Items per page should be between 10 and 100

# Response Example

Correct Example:
HTTP/1.1 200 OK
{
    "number": 0,
    "total": 7,
    "size": 50,
    "list": [
        {
            "mobile_hash": "",
            "date": "20220414",
            "log_id": "d9d3ed23d6804b828aa2e95eebe18ef2",
            "authDetail": {
                "auth_method": "",
                "error_reason": "UsernameNotFoundException : Cannot found user, principal=cq04130007",
                "error_type": "UsernameNotFoundException"
            },
            "operation_type": "",
            "real_user_name": "cq04130007",
            "user_name": "",
            "mobile": "",
            "target_type": "APP",
            "enterprise_id": "20220117125616565-8E52-4D577FE9F",
            "typeDetail": {
                "error_reason": "UsernameNotFoundException : Cannot found user, principal=cq04130007"
            },
            "result": false,
            "log_type": "userLog",
            "event_type": "Password login",
            "hour": "10",
            "zone": "",
            "user_id": "",
            "target_app": "用户中心",
            "object_name": "",
            "event_time": 1649902555104,
            "generalDetail": {
                "protocol_type": "",
                "province": "湖北省",
                "city": "武汉市",
                "browser": "Chrome 10",
                "os_name": "Windows",
                "session_id": "",
                "device_type": "PC",
                "ip_address": "119.98.191.208",
                "is_secondary_auth": "",
                "location_type": "inland"
            }
        },
        {
            "mobile_hash": "",
            "date": "20220414",
            "log_id": "d9d3ed23d6804b828aa2e95eebe18ef2",
            "authDetail": {
                "auth_method": "",
                "error_reason": "UsernameNotFoundException : Cannot found user, principal=cq04130007",
                "error_type": "UsernameNotFoundException"
            },
            "operation_type": "",
            "real_user_name": "cq04130007",
            "user_name": "",
            "mobile": "",
            "target_type": "APP",
            "enterprise_id": "20220117125616565-8E52-4D577FE9F",
            "typeDetail": {
                "error_reason": "UsernameNotFoundException : Cannot found user, principal=cq04130007"
            },
            "result": false,
            "log_type": "userLog",
            "event_type": "Password login",
            "hour": "10",
            "zone": "",
            "user_id": "",
            "target_app": "用户中心",
            "object_name": "",
            "event_time": 1649902555104,
            "generalDetail": {
                "protocol_type": "",
                "province": "湖北省",
                "city": "武汉市",
                "browser": "Chrome 10",
                "os_name": "Windows",
                "session_id": "",
                "device_type": "PC",
                "ip_address": "119.98.191.208",
                "is_secondary_auth": "",
                "location_type": "inland"
            }
        },
        {
            "mobile_hash": "",
            "date": "20220414",
            "log_id": "d9d3ed23d6804b828aa2e95eebe18ef2",
            "authDetail": {
                "auth_method": "",
                "error_reason": "UsernameNotFoundException : Cannot found user, principal=cq04130007",
                "error_type": "UsernameNotFoundException"
            },
            "operation_type": "",
            "real_user_name": "cq04130007",
            "user_name": "",
            "mobile": "",
            "target_type": "APP",
            "enterprise_id": "20220117125616565-8E52-4D577FE9F",
            "typeDetail": {
                "error_reason": "UsernameNotFoundException : Cannot found user, principal=cq04130007"
            },
            "result": false,
            "log_type": "userLog",
            "event_type": "Password login",
            "hour": "10",
            "zone": "",
            "user_id": "",
            "target_app": "用户中心",
            "object_name": "",
            "event_time": 1649902555104,
            "generalDetail": {
                "protocol_type": "",
                "province": "湖北省",
                "city": "武汉市",
                "browser": "Chrome 10",
                "os_name": "Windows",
                "session_id": "",
                "device_type": "PC",
                "ip_address": "119.98.191.208",
                "is_secondary_auth": "",
                "location_type": "inland"
            }
        },
        {
            "mobile_hash": "",
            "date": "20220414",
            "log_id": "d9d3ed23d6804b828aa2e95eebe18ef2",
            "authDetail": {
                "auth_method": "",
                "error_reason": "UsernameNotFoundException : Cannot found user, principal=cq04130007",
                "error_type": "UsernameNotFoundException"
            },
            "operation_type": "",
            "real_user_name": "cq04130007",
            "user_name": "",
            "mobile": "",
            "target_type": "APP",
            "enterprise_id": "20220117125616565-8E52-4D577FE9F",
            "typeDetail": {
                "error_reason": "UsernameNotFoundException : Cannot found user, principal=cq04130007"
            },
            "result": false,
            "log_type": "userLog",
            "event_type": "Password login",
            "hour": "10",
            "zone": "",
            "user_id": "",
            "target_app": "用户中心",
            "object_name": "",
            "event_time": 1649902555104,
            "generalDetail": {
                "protocol_type": "",
                "province": "湖北省",
                "city": "武汉市",
                "browser": "Chrome 10",
                "os_name": "Windows",
                "session_id": "",
                "device_type": "PC",
                "ip_address": "119.98.191.208",
                "is_secondary_auth": "",
                "location_type": "inland"
            }
        },
        {
            "mobile_hash": "",
            "date": "20220414",
            "log_id": "d9d3ed23d6804b828aa2e95eebe18ef2",
            "authDetail": {
                "auth_method": "",
                "error_reason": "UsernameNotFoundException : Cannot found user, principal=cq04130007",
                "error_type": "UsernameNotFoundException"
            },
            "operation_type": "",
            "real_user_name": "cq04130007",
            "user_name": "",
            "mobile": "",
            "target_type": "APP",
            "enterprise_id": "20220117125616565-8E52-4D577FE9F",
            "typeDetail": {
                "error_reason": "UsernameNotFoundException : Cannot found user, principal=cq04130007"
            },
            "result": false,
            "log_type": "userLog",
            "event_type": "Password login",
            "hour": "10",
            "zone": "",
            "user_id": "",
            "target_app": "用户中心",
            "object_name": "",
            "event_time": 1649902555104,
            "generalDetail": {
                "protocol_type": "",
                "province": "湖北省",
                "city": "武汉市",
                "browser": "Chrome 10",
                "os_name": "Windows",
                "session_id": "",
                "device_type": "PC",
                "ip_address": "119.98.191.208",
                "is_secondary_auth": "",
                "location_type": "inland"
            }
        },
        {
            "mobile_hash": "",
            "date": "20220414",
            "log_id": "d9d3ed23d6804b828aa2e95eebe18ef2",
            "authDetail": {
                "auth_method": "",
                "error_reason": "UsernameNotFoundException : Cannot found user, principal=cq04130007",
                "error_type": "UsernameNotFoundException"
            },
            "operation_type": "",
            "real_user_name": "cq04130007",
            "user_name": "",
            "mobile": "",
            "target_type": "APP",
            "enterprise_id": "20220117125616565-8E52-4D577FE9F",
            "typeDetail": {
                "error_reason": "UsernameNotFoundException : Cannot found user, principal=cq04130007"
            },
            "result": false,
            "log_type": "userLog",
            "event_type": "Password login",
            "hour": "10",
            "zone": "",
            "user_id": "",
            "target_app": "用户中心",
            "object_name": "",
            "event_time": 1649902555104,
            "generalDetail": {
                "protocol_type": "",
                "province": "湖北省",
                "city": "武汉市",
                "browser": "Chrome 10",
                "os_name": "Windows",
                "session_id": "",
                "device_type": "PC",
                "ip_address": "119.98.191.208",
                "is_secondary_auth": "",
                "location_type": "inland"
            }
        },
        {
            "mobile_hash": "",
            "date": "20220414",
            "log_id": "d9d3ed23d6804b828aa2e95eebe18ef2",
            "authDetail": {
                "auth_method": "",
                "error_reason": "UsernameNotFoundException : Cannot found user, principal=cq04130007",
                "error_type": "UsernameNotFoundException"
            },
            "operation_type": "",
            "real_user_name": "cq04130007",
            "user_name": "",
            "mobile": "",
            "target_type": "APP",
            "enterprise_id": "20220117125616565-8E52-4D577FE9F",
            "typeDetail": {
                "error_reason": "UsernameNotFoundException : Cannot found user, principal=cq04130007"
            },
            "result": false,
            "log_type": "userLog",
            "event_type": "Password login",
            "hour": "10",
            "zone": "",
            "user_id": "",
            "target_app": "用户中心",
            "object_name": "",
            "event_time": 1649902555104,
            "generalDetail": {
                "protocol_type": "",
                "province": "湖北省",
                "city": "武汉市",
                "browser": "Chrome 10",
                "os_name": "Windows",
                "session_id": "",
                "device_type": "PC",
                "ip_address": "119.98.191.208",
                "is_secondary_auth": "",
                "location_type": "inland"
            }
        }
    ]
}


Error Example:
HTTP/1.1 400 Bad Request
{
    "error_code": "1003",
    "error_msg": "The parameter limit is 10-100."
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297

# Return Parameters

Parameter Name Chinese Name Type Description
log_id Log ID String
data Time String
mobile Mobile Number String
mobile_hash Mobile Number Hash String
authDetail Authentication Details Object
operation_type Operation Type String
real_user_name Authenticated Username String
user_name Username String
target_type Target Type String
enterprise_id Tenant ID String
typeDetail Type Description String
result Result Boolean
log_type Log Type String
hour Hour String
zone Zone String
user_id User ID String
target_app Target Name String
object_name Object Name String
event_time Event Time String
generalDetail General Details Object

Okay, please provide the Markdown content you need translated.

Query Authentication Count