API - Account Logins

Account Logins

This endpoint provides access to the audit log for account login activities.

The login history includes detailed information about each authentication event, including:

This data is valuable for security monitoring, compliance reporting, and troubleshooting authentication issues.

Endpoints

get/api/v3/iam/account_logins

Return a paginated list of iam/account/logins

Input Schema

object
page?:
object
The page number, default to 1
number?: integer
The number of items per page, default to 1000
size?: integer
The sort order, comma separated list of fields. See sorting section for more details
sort?: string
Set to true to return the total number of items in the collection
count?: boolean
filter?:
object
id?: unknown
account_id?: unknown
role?: unknown
date?: unknown
ip?: unknown
account_id?: unknown
The related resources to include in the response. Allowed resources are:
- `account`
- `account.person`
included?:
array
Elements: string
The fields to include in the response.
The key is the resource type and the value is an array of fields.
fields?:
dictionary
Values: array

Typescript

type InputSchema = {
  page?: {
    // The page number, default to 1
    number?: number;
    // The number of items per page, default to 1000
    size?: number;
  };
  // The sort order, comma separated list of fields. See sorting section for more details
  sort?: string;
  // Set to true to return the total number of items in the collection
  count?: boolean;
  filter?: {
    id?: any;
    account_id?: any;
    role?: any;
    date?: any;
    ip?: any;
    account_id?: any;
  };
  // The related resources to include in the response. Allowed resources are:
  // - `account`
  // - `account.person`
  included?: Array<string>;
  // The fields to include in the response.
  // The key is the resource type and the value is an array of fields.
  fields?: { [key: string]: Array<any> };
};

Output Schema

object
data:
array
Elements:
object
type: string
id?: string
attributes?:
object
id?: integer
role?: string
date?: datetime
ip?: open struct
relationships?: open struct
included?:
array
Elements: open struct

Typescript

type OutputSchema = {
  data: Array<{
    type: string;
    id?: string;
    attributes?: {
      id?: number;
      role?: string;
      date?: Date;
      ip?: Record<string, any>;
    };
    relationships?: Record<string, any>;
  }>;
  included?: Array<Record<string, any>>;
};