Get all login events.

GET 
/api/admin/logins

Returns all login events in the Unleash system. You can optionally get them in CSV format by specifying the Accept header as text/csv.

Responses

200

loginHistorySchema

application/json

Schema

Schema

events

object[]

required

A list of login events

Array [

id integerrequired

The event's ID. Event IDs are incrementing integers. In other words, a more recent event will always have a higher ID than an older event.

Possible values: >= 1

Example: 13

username string

The username of the user that attempted to log in. Will return "Incorrectly configured provider" when attempting to log in using a misconfigured provider.

Example: admin

auth_type string

The authentication type used to log in.

Example: simple

created_at date-time

The date and time of when the login was attempted.

Example: 2023-03-01T12:04:26.061Z

successful boolean

Whether the login was successful or not.

Example: true

ip stringnullable

The IP address of the client that attempted to log in.

Example: ::ffff:127.0.0.1

failure_reason stringnullable

The reason for the login failure. This property is only present if the login was unsuccessful.

Example: No user found

]

Example (from schema)

{
  "events": [
    {
      "id": 13,
      "username": "admin",
      "auth_type": "simple",
      "created_at": "2023-03-01T12:04:26.061Z",
      "successful": true,
      "ip": "::ffff:127.0.0.1",
      "failure_reason": "No user found"
    }
  ]
}

text/csv

Schema

Schema

string

204

This response has no body.

401

Authorization information is missing or invalid. Provide a valid API token as the authorization header, e.g. authorization:*.*.my-admin-token.

application/json

Schema

Schema

id string
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
name string
The name of the error kind
Example: AuthenticationRequired
message string
A description of what went wrong.
Example: You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login.

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "AuthenticationRequired",
  "message": "You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login."
}

404

The requested resource was not found.

application/json

Schema

Schema

id string
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
name string
The name of the error kind
Example: NotFoundError
message string
A description of what went wrong.
Example: Could not find the addon with ID "12345".

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "NotFoundError",
  "message": "Could not find the addon with ID \"12345\"."
}

Loading...