List User’s Login Events information¶

Overview¶

List user’s login events in the designated contract.

Classification¶

List

API Operation Object¶

user

Synchronous / Asynchronous¶

Synchronous

Request¶

HTTP Request Method¶

GET

HTTP Request Path¶

{api_endpoint}/api/v2/users/{user_id}/login-events

HTTP Request Header¶

X-Auth-Token: <token_id>

HTTP Request Body¶

None

Request Parameter¶

Response¶

Response Header¶

Format¶

HTTP/1.1 <response_code> <response_code>       (ex. 200 200)

<response_code>: see “HTTP Responses” section
<message>: message based on the response code

(skip auto insert field such as “Connection” and “Content-Length”, “Set-Cookie”, etc.)

Response Code¶

Response Codes¶
response code	condition
200	normal end
400	request format is invalid
401	unauthorized
403	Not permitted for this user
405	Method not allowed
404	not found a specified resource

Response Body¶

Format¶

{
    "user_id": "ecidXXXXXXXXXX",
    "events": [
        {
            "event_type": "logout"(login_success/login_failure/logout),
            "event_datetime": "yyyy-mm-dd hh:mm:ss",
            "client_ip_address": "XXX.XXX.XXX.XXX"
        },
        {
            "event_type": "login_success",
            "event_datetime": "yyyy-mm-dd hh:mm:ss",
            "client_ip_address": "XXX.XXX.XXX.XXX"
        },
        ...
    ]
}

Response Parameter¶

Response Parameters¶
item	format	description
user_id	String	target user_id
events	Array	contains event data
events.event_type	String	Three event types are provided: ‘login_success’, ‘login_failure’ and ‘logout’.
events.event_datetime	String	the event occured time. (YYYY-MM-DD HH:MM:SS(UTC))
events.client_ip_address	String	Client IP address when the event occurred

Sample Request and Response¶

Sample API Request¶

curl -1 -i -H"X-Auth-Token: 3477558597db47768fb1256baf52a42c" https://sss-jp1-ecl.api.ntt.com/api/v2/users/ecid1000005697/login-events

Sample API Response¶

HTTP/1.1 200 200
Date: Sun, 28 Feb 2016 05:51:49 GMT
Content-Type: application/json
Content-Length: 945
Connection: keep-alive
Set-Cookie: TS0183560f=01059ca7b134f0aed4c87756c80c52afca561aa1d2fc7328ae5f014b4990cc8241d528d006; Path=/

{"user_id":"ecid1000005697","events":[{"event_type":"logout","event_datetime":"yyyy-mm-ddhh:mm:ss","client_ip_address":"XXX.XXX.XXX.XXX"},{"event_type":"login_success","event_datetime":"yyyy-mm-ddhh:mm:ss","client_ip_address":"XXX.XXX.XXX.XXX"}]}

Sample Error Message¶

HTTP/1.1 401 401
Date: Sun, 28 Feb 2016 05:59:27 GMT
Content-Type: application/json
Content-Length: 62
Connection: keep-alive
Set-Cookie: TS0183560f=01059ca7b1edfd94c1eac60116201d1b6a5adee27dce11ed34d6fccba6737a7cb6e6c20f58; Path=/
{"code":401,"title":"Unauthorized","message":"Invalid token."}

Update User

Update Auto Role Settings (For partner user only)