Contents x
    APIs for Audit Logs
    • 19 May 2025
    • 51 Minutes to read
    • Print
    • Dark
      Light
    Contents

    APIs for Audit Logs

    • Updated on 19 May 2025
    • 51 Minutes to read
    • Print
    • Dark
      Light
    Article summary

    WHAT: Introduction to the APIs for Audit Logs

    The Audit Log APIs allow you to read and extract Audit Logs from within Board for log entries of several Action Types that are automatically recorded in Board. These audit logs make it possible to monitor and control access permissions to critical resources. Subscription Hub 9.0+ is mandatory to enable their activation.

    Moreover, several improvements have been made in version 14.3 to the content of the Audit log, enriching a lot of the information tracked. So although not mandatory, it is suggested to use such APIs in combination with version 14.3 (or later).

    These Audit Log APIs simplify integration with third-party SIEM (Security Information and Event Management) tools like SPLUNK, Azure Log Analyzer, or similar for account and access management and auditing. Compliance, retention and forensics. Internal data management features for legal considerations are greatly facilitated with comprehensive security object tracking.

    There are seven separate APIs available for the various groups of Action Type, plus an additional “catch all” API that returns data from all of those groups and some additional Actions that are not included in these seven API groups:

    Log Type

    Description of the log entries

    Users

    Creating, updating and deleting user accounts, either individually or in bulk. This includes events of the following action types: USER_CREATED, USER_UPDATED, USER_DELETED, USER_IMPORTED, EXPORT_USERS

    Login

    Login attempts and platform connections. This includes events of the following action types: LOGIN, CONNECT_TO_PLATFORM, DISCONNECT_FROM_PLATFORM

    Permission Groups

    Creating, updating, and deleting permission groups and setting the default permission group. This includes events of the following action types: PERMISSION_GROUP_CREATED, PERMISSION_GROUP_UPDATED, PERMISSION_GROUP_DELETED, PERMISSION_GROUP_SET_AS_DEFAULT, REMOVE_DEFAULT_PERMISSION_GROUP

    Roles

    Creating, updating and deleting user roles. This includes events of the following action types: ROLE_CREATED, ROLE_UPDATED, ROLE_DELETED

    Application Profiles (Features)

    Creating, updating and deleting application profiles. This includes events of the following action types: APPLICATION_PROFILE_CREATED, APPLICATION_PROFILE_UPDATED, APPLICATION_PROFILE_DELETED

    Folder Profiles (Capsules)

    Creating, updating and deleting capsule folders. This includes events of the following action types: FOLDER_PROFILE_CREATED, FOLDER_PROFILE_UPDATED, FOLDER_PROFILE_DELETED

    Data Models

    Creating, updating and deleting Board Data Models. This includes events of the following action types: DATABASE_PROFILE_CREATED, DATABASE_PROFILE_UPDATED, DATABASE_PROFILE_DELETED

    API Calls per day

    These APIs are not included in the default daily call limits for Board APIs. They can be unlocked by purchasing a higher API Calls Tier. Please refer to your Key Account Manager/Sales Manager for a quotation.

    API Queries

    To create custom API queries to expose the Board Audit Logs, you need to be confident with APIs and Board terminology. See The API Queries section for complete information on how to construct and manage custom API queries. External applications can also use the APIs, with a Client API user created in the Subscription Hub with the necessary authorization to access to the appropriate Board Platform. An authorization token must be generated by the necessary Client API user before making any request.

    HOW: Details of the Audit Log APIs

    API technical details

    A POST method is used to generate a request for a log of the selected log entries returned in JSON or CEF format. The request can be refined with one or more parameters to filter the data returned:

    • Date/time range. Specifying either start and end dates, or a “most recent” datetime duration for log entries in the most recent days, hours, minutes or seconds. To restrict queries from consuming too many resources, one of these date/time restrictions is MANDATORY for all of the APIs.

    • Action type. This filter is only available for the “Full audit” option to specify either one or more Action Types to be used as a filter.

    • Search text. This filter is only available for the “Full audit” option to specify a text string that must match text inside the log entries.

    To receive an audit log API response in CEF format, use "Accept: application/cef" as a request header parameter instead of "Accept: application/json" .

    Details of the individual APIs

    Login API

    The "login" API endpoint allows retrieval from the log of login events for a specific date-time range. The API employs the POST method to send a request with the API parameters encapsulated in the body.

    Parameters

    This API only accepts and requires a date-time range as the mandatory parameter to restrict the size of the data set returned, either with start and end date-times, or as a "most recent" time duration.

    Start and end dates must be in ISO 8601 format, or the duration must be expressed as an integer number of days (d), hours (h), minutes (m) or seconds (s).

    Submission method: POST

    https://board-api.board.com/api/v1/log/login

    Parameter examples

    { "startDate":"2025-01-01T07:35:00Z", "endDate":"2025-04-18T23:38:00Z" }
{ "timeDuration":"18h" }
{ "timeDuration":"100m" }

    Curl example

    curl --location 'https://board-api.board.com/api/v1/log/login' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••' \
--data '{
   "timeDuration":"48h"
}'

    JSON request schema

    {
  "openapi": "3.0.0",
  "info": {
    "title": "Audit Log API - Login",
    "version": "1.0.0",
    "description": ""
  },
  "servers": [
    {
      "url": "board-api.board.com"
    }
  ],
  "paths": {
    "/api/v1/log/login": {
      "parameters": [],
      "post": {
        "summary": "login",
        "parameters": [],
        "responses": {},
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "startDate": {
                    "type": "string",
                    "format": "date-time"
                  },
                  "endDate": {
                    "type": "string",
                    "format": "date-time"
                  }  }  }  }  }  }  }  }  }  }

    JSON response schema

    {
  "title": "Generated schema for Login",
  "type": "object",
  "properties": {
    "logs": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ipAddress": { "type": "string" },
          "user": { "type": "string" },
          "info": {
            "type": "object",
            "properties": {
              "User": { "type": "string" },
              "Result": { "type": "string" },
              "Info": { "type": "string" },
              "IpAddress": { "type": "string" },
              "RequestedBy": { "type": "string" },
              "Id": { "type": "string" },
              "DisplayName": { "type": "string" },
              "Username": { "type": "string" },
              "Email": { "type": "string" },
              "PlatformAuthorizations": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "Role": { "type": "string" },
                    "Platform": { "type": "string" },
                    "License": { "type": "string" },
                    "IsAdmin": { "type": "boolean" } },
                  "required": [ "Role", "Platform", "License", "IsAdmin" ] } },
              "Disabled": { "type": "boolean" },
              "Authentication": { "type": "string" },
              "PhoneNumber": { "type": "string" },
              "EmailConfirmed": { "type": "boolean" },
              "PasswordNeverExpires": { "type": "boolean" },
              "License": { "type": "string" },
              "PermissionGroup": { "type": "string" },
              "Culture": { "type": "string" },
              "Office": { "type": "boolean" },
              "Mobile": { "type": "boolean" },
              "MetadataValues": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "Name": { "type": "string" },
                    "Value": { "type": "string" } },
                  "required": [ "Name", "Value" ] } },
              "SubscriptionHubAuthorizations": {
                "type": "array",
                "items": { "type": "string" } },
              "CollaborationGroups": { "type": "array", "items": {} },
              "Platform": { "type": "string" },
              "Name": { "type": "string" },
              "ApplicationProfile": { "type": "string" },
              "FolderProfiles": { "type": "array", "items": {} },
              "DatabaseProfiles": { "type": "array", "items": {} },
              "UserSelections": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "Database": { "type": "string" },
                    "CustomSelection": { "type": "string" },
                    "Selections": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "EntityName": { "type": "string" },
                          "EntityPhisicalName": { "type": "string" } },
                        "required": [ "EntityName", "EntityPhisicalName" ] } },
                    "AnySelectBasedOnCubeList": { "type": "boolean" } },
                  "required": [ "Database", "CustomSelection", "Selections", "AnySelectBasedOnCubeList" ] } },
              "CanExecuteSecurityCriticalProcedures": { "type": "boolean" },
              "DenyLayoutDesigner": { "type": "boolean" },
              "DenySelect": { "type": "boolean" },
              "DenyExportAndPrint": { "type": "boolean" },
              "DenyProcedureEditing": { "type": "boolean" },
              "AllowCorporateIdentityDesign": { "type": "boolean" },
              "AllowValet": { "type": "boolean" },
              "DenySubscribeAndSendTo": { "type": "boolean" },
              "PublicApiScopeDenied": {
                "type": "array",
                "items": {} } },
            "required": [] },
          "actionType": { "type": "string" },
          "date": { "type": "string" } },
        "required": [ "ipAddress", "user", "info", "actionType", "date" ] } } },
  "required": [ "logs" ]
}

    JSON response example

    {
    "logs": [
        {
            "result": "LOGIN SUCCEEDED",
            "ipAddress": "111.11.111.11",
            "info": "EXTERNAL AUTHENTICATION VERIFIED",
            "user": "planner@board.com",
            "platform": "",
            "connectionId": "",
            "actionType": "LOGIN",
            "date": "2025-04-30T20:00:03.105+00:00"
        },
        {
            "result": "LOGOUT",
            "ipAddress": "111.11.111.11",
            "info": "",
            "user": "planner@board.com ",
            "platform": "",
            "connectionId": "",
            "actionType": "LOGIN",
            "date": "2025-04-30T19:59:45.711+00:00"
        },
        {
            "result": "LOGIN SUCCEEDED",
            "ipAddress": "111.11.111.11",
            "info": "PASSWORD VERIFIED",
            "user": "planner@board.com ",
            "platform": "",
            "connectionId": "",
            "actionType": "LOGIN",
            "date": "2025-04-30T19:56:54.807+00:00"
        },
        {
            "result": "LOGIN FAILED",
            "ipAddress": "111.11.111.11",
            "info": "INVALID CREDENTIALS",
            "user": "planner@board.com",
            "platform": "",
            "connectionId": "",
            "actionType": "LOGIN",
            "date": "2025-04-14T10:55:19.258+00:00"
        }
    ]
}

    CEF response example

    CEF:0|Security|LoginManager|1.0|LOGIN|Login Event|10|src=111.11.111.11 suser=planner@board.com platform= connectionId= result=LOGIN SUCCEEDED info=PASSWORD VERIFIED start=2025-04-22T12:35:40Z
CEF:0|Security|LoginManager|1.0|LOGIN|Login Event|10|src=111.11.111.11 suser=Administrator+3 platform= connectionId= result=LOGOUT info= start=2025-04-25T10:55:22Z
CEF:0|Security|LoginManager|1.0|LOGIN|Login Event|10|src=111.11.111.11 suser= platform= connectionId= result=LOGIN FAILED info=EXTERNAL AUTHENTICATION ERROR start=2025-04-22T12:35:40Z

    Users API

    The "users" API endpoint allows retrieval from the log of maintenance events on Users and their access rights for a specific date-time range. The API employs the POST method to send a request with the API parameters encapsulated in the body.

    Parameters

    This API only accepts and requires a date-time range as the mandatory parameter to restrict the size of the data set returned, either with start and end date-times, or as a "most recent" time duration.

    Start and end dates must be in ISO 8601 format, or the duration must be expressed as an integer number of days (d), hours (h), minutes (m) or seconds (s).

    Submission method: POST

    https://board-api.board.com/api/v1/log/users

    Parameter examples

    { "startDate":"2025-01-01T07:35:00Z", "endDate":"2025-04-18T23:38:00Z" }
{ "timeDuration":"18h" }
{ "timeDuration":"100m" }

    Curl example

    curl --location 'https://board-api.board.com/api/v1/log/users' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••' \
--data '{
    "startDate":"2025-01-01T07:35:00Z",
    "endDate":"2025-04-17T23:38:00Z"
}'

    JSON request schema

    {
  "openapi": "3.0.0",
  "info": {
    "title": "Audit Log API - Users",
    "version": "1.0.0",
    "description": ""
  },
  "servers": [
    { "url": "board-api.board.com" }
  ],
  "paths": {
    "/api/v1/log/users": {
      "parameters": [],
      "post": {
        "summary": "Users",
        "parameters": [],
        "responses": {},
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "startDate": {
                    "type": "string",
                    "format": "date-time"
                  },
                  "endDate": {
                    "type": "string",
                    "format": "date-time"
                  }  }  }  }  }  }  }  }  }  }

    JSON response schema

    {
  "description": "Generated schema for Users",
  "type": "object",
  "properties": {
    "logs": {
      "type": "array",
      "uniqueItems": true,
      "minItems": 1,
      "items": {
        "required": [ "id", "displayName", "username", "email", "authentication", "disabled",
          "phoneNumber", "emailConfirmed", "passwordNeverExpires", "license",
          "permissionGroup", "culture", "office", "mobile", "actionType",
          "subscriptionHubAuthorizationsDefined", "requestedBy", "date" ],
        "properties": {
          "id": { "type": "string", "minLength": 1 },
          "displayName": { "type": "string", "minLength": 1 },
          "username": { "type": "string", "minLength": 1 },
          "email": { "type": "string", "minLength": 1 },
          "authentication": { "type": "string", "minLength": 1 },
          "disabled": { "type": "boolean" },
          "phoneNumber": { "type": "string", "minLength": 1 },
          "emailConfirmed": { "type": "boolean" },
          "passwordNeverExpires": { "type": "boolean" },
          "license": { "type": "string", "minLength": 1 },
          "permissionGroup": { "type": "string", "minLength": 1 },
          "culture": { "type": "string", "minLength": 1 },
          "office": { "type": "boolean" },
          "mobile": { "type": "boolean" },
          "metadataValues": {
            "type": "array",
            "uniqueItems": true,
            "minItems": 1,
            "items": {
              "required": [ "name", "value" ],
              "properties": {
                "name": { "type": "string", "minLength": 1 },
                "value": { "type": "string", "minLength": 1 } } } },
          "collaborationGroups": {
            "type": "array",
            "items": { "required": [], "properties": {} } },
          "actionType": { "type": "string", "minLength": 1 },
          "platformAuthorizations": {
            "type": "array",
            "uniqueItems": true,
            "minItems": 1,
            "items": {
              "required": [ "role", "platform", "license", "isAdmin" ],
              "properties": {
                "role": { "type": "string", "minLength": 1 },
                "platform": { "type": "string", "minLength": 1 },
                "license": { "type": "string", "minLength": 1 },
                "isAdmin": { "type": "boolean" } } } },
          "subscriptionHubAuthorizationsDefined": { "type": "boolean" },
          "subscriptionHubAuthorizations": {
            "type": "array",
            "items": { "required": [], "properties": {} } },
          "requestedBy": { "type": "string", "minLength": 1 },
          "date": { "type": "string", "minLength": 1 } } } } },
  "required": [ "logs" ]
}

    JSON response example

    {
    "logs": [
        {
            "id": "32ae5828-c195-4878-a7fd-0cf0d9ec93ea",
            "displayName": "abcTestUser",
            "username": "abcTestUser@board.com",
            "email": "abcTestUser@board.com",
            "authentication": "Board authentication",
            "disabled": false,
            "phoneNumber": " ",
            "emailConfirmed": false,
            "passwordNeverExpires": false,
            "license": "Lite Plus",
            "permissionGroup": " ",
            "culture": " ",
            "office": false,
            "mobile": false,
            "metadataValues": [
                {
                    "name": "Generic metadata 1",
                    "value": "TYPE 1"
                }
            ],
            "collaborationGroups": [],
            "actionType": "USER_CREATED",
            "platformAuthorizations": [
                {
                    "role": "admin",
                    "platform": "board-api.board.com",
                    "license": "Lite Plus",
                    "isAdmin": false
                }
            ],
            "subscriptionHubAuthorizationsDefined": false,
            "subscriptionHubAuthorizations": [
                "Users",
                "UsersMetadata",
                "SignInPage",
                "Enrollment",
                "Collaboration",
                "IdentityProviderFederation",
                "Licenses",
                "GeneralSettings",
                "PermissionGroups"
            ],
            "requestedBy": "Administrator+3",
            "date": "2025-04-17T14:31:47.103+00:00"
        }
  ]
}

    CEF response example

    CEF:0|Security|UserManager|1.0|100|USER_UPDATED|10|id=0ddc018a-f3b1-4893-939f-0b2f71641dc7 suser=abcTestUser@board.com displayName=abcTestUser Updated email=abcTestUser@board.com authentication=Board authentication disabled=False phoneNumber=  emailConfirmed=False passwordNeverExpires=False license=Developer permissionGroup=  culture=  office=False mobile=False metadataValues=[{"Name":"Generic metadata 1","Value":"Updatetext"}] collaborationGroups=[] requestedBy=Administrator+3 platformAuthorizations=[{"Role":"admin","Platform":"board-api.board.com","License":"Developer","IsAdmin":true}] subscriptionHubAuthorizations=["Users","UsersMetadata","SignInPage","Enrollment","Collaboration","IdentityProviderFederation","Licenses","GeneralSettings","PermissionGroups"] start=2025-04-17T14:31:17Z

    Permission Groups API

    The "permissiongroups" API endpoint allows retrieval from the log of maintenance events on Permission Groups and their access rights for a specific date-time range. The API employs the POST method to send a request with the API parameters encapsulated in the body.

    Parameters

    This API only accepts and requires a date-time range as the mandatory parameter to restrict the size of the data set returned, either with start and end date-times, or as a "most recent" time duration.

    Start and end dates must be in ISO 8601 format, or the duration must be expressed as an integer number of days (d), hours (h), minutes (m) or seconds (s).

    Submission method: POST

    https://board-api.board.com/api/v1/log/permissiongroups

    Parameter examples

    { "startDate":"2025-01-01T07:35:00Z", "endDate":"2025-04-18T23:38:00Z" }
{ "timeDuration":"18h" }
{ "timeDuration":"100m" }

    Curl example

    curl --location 'https://board-api.board.com/api/v1/log/permissiongroups' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••' \
--data '{
    "startDate":"2025-01-01T07:35:00Z",
    "endDate":"2025-04-18T23:38:00Z" 
}'

    JSON request schema

    {
  "openapi": "3.0.0",
  "info": {
    "title": "Audit Log API - Permission Groups",
    "version": "1.0.0",
    "description": ""
  },
  "servers": [
    {
      "url": "board-api.board.com"
    }
  ],
  "paths": {
    "/api/v1/log/permissiongroups": {
      "parameters": [],
      "post": {
        "summary": "Permission Groups",
        "parameters": [],
        "responses": {},
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "startDate": {
                    "type": "string",
                    "format": "date-time"
                  },
                  "endDate": {
                    "type": "string",
                    "format": "date-time"
                  }  }  }  }  }  }  }  }  }  }

    JSON response schema

    {
  "description": "Generated schema for Permission Groups",
  "type": "object",
  "properties": {
    "logs": {
      "type": "array",
      "uniqueItems": true,
      "minItems": 1,
      "items": {
        "required": [
          "id",
          "name",
          "platformAuthorizationsDefined",
          "authenticationType",
          "office",
          "mobile",
          "isDefault",
          "actionType",
          "subscriptionHubAuthorizationsDefined",
          "requestedBy",
          "date" ],
        "properties": {
          "id": { "type": "string", "minLength": 1 },
          "name": { "type": "string", "minLength": 1 },
          "platformAuthorizationsDefined": { "type": "boolean" },
          "authenticationType": { "type": "string", "minLength": 1 },
          "office": { "type": "boolean" },
          "mobile": { "type": "boolean" },
          "isDefault": { "type": "boolean" },
          "groupMetadataValues": {
            "type": "array",
            "items": { required": [], "properties": {} } },
          "actionType": { "type": "string", "minLength": 1 },
          "platformAuthorizations": {
            "type": "array",
            "uniqueItems": true,
            "minItems": 1,
            "items": {
              "required": [ "role", "platform", "license", "isAdmin" ],
              "properties": {
                "role": { "type": "string", "minLength": 1 },
                "platform": { "type": "string", "minLength": 1 },
                "license": { "type": "string", "minLength": 1 },
                "isAdmin": { "type": "boolean" } } } },
          "subscriptionHubAuthorizationsDefined": { "type": "boolean" },
          "subscriptionHubAuthorizations": {
            "type": "array",
            "items": { "required": [], "properties": {} } },
          "requestedBy": { "type": "string", "minLength": 1 },
          "date": { "type": "string", "minLength": 1 } } } } },
  "required": [ "logs" ]
}

    JSON response examples

    {
    "logs": [
        { 
            "id": "8b78dbc6-37e6-49ba-8c5e-08dd626cfb0b",
            "name": "TEST NEW GROUP",
            "platformAuthorizationsDefined": false,
            "authenticationType": "Board authentication",
            "office": false,
            "mobile": false,
            "isDefault": false,
            "groupMetadataValues": [],
            "actionType": "PERMISSION_GROUP_CREATED",
            "platformAuthorizations": [
                {
                    "role": "admin",
                    "platform": "board-api.board.com",
                    "license": "Developer",
                    "isAdmin": true
                }
            ],
            "subscriptionHubAuthorizationsDefined": true,
            "subscriptionHubAuthorizations": [
                "Users",
                "UsersMetadata",
                "SignInPage",
                "Enrollment",
                "Collaboration",
                "IdentityProviderFederation",
                "Licenses",
                "GeneralSettings",
                "PermissionGroups"
            ],
            "requestedBy": "planner@board.com",
            "date": "2025-03-13T20:23:56.746+00:00"
        }
    ]
}

    {
    "logs": [
        {
            "id": "8b78dbc6-37e6-49ba-8c5e-08dd626cfb0b",
            "name": "TEST DEFAULT GROUP",
            "platformAuthorizationsDefined": false,
            "authenticationType": "Board authentication",
            "office": false,
            "mobile": false,
            "isDefault": true,
            "groupMetadataValues": [],
            "actionType": "PERMISSION_GROUP_SET_AS_DEFAULT",
            "platformAuthorizations": [
                {
                    "role": "admin",
                    "platform": "board-api.board.com",
                    "license": "Developer",
                    "isAdmin": true
                }
            ],
            "subscriptionHubAuthorizationsDefined": true,
            "subscriptionHubAuthorizations": [
                "Users",
                "UsersMetadata",
                "SignInPage",
                "Enrollment",
                "Collaboration",
                "IdentityProviderFederation",
                "Licenses",
                "GeneralSettings",
                "PermissionGroups"
            ],
            "requestedBy": "planner@board.com",
            "date": "2025-03-13T20:25:03.849+00:00"
        }
    ]
}

    {
    "logs": [
        {
            "id": "8b78dbc6-37e6-49ba-8c5e-08dd626cfb0b",
            "name": "TEST 66336",
            "platformAuthorizationsDefined": false,
            "authenticationType": "Board authentication",
            "office": false,
            "mobile": false,
            "isDefault": false,
            "groupMetadataValues": [],
            "actionType": "REMOVE_DEFAULT_PERMISSION_GROUP",
            "platformAuthorizations": [
                {
                    "role": "admin",
                    "platform": "board-api.board.com",
                    "license": "Developer",
                    "isAdmin": true
                }
            ],
            "subscriptionHubAuthorizationsDefined": true,
            "subscriptionHubAuthorizations": [
                "Users",
                "UsersMetadata",
                "SignInPage",
                "Enrollment",
                "Collaboration",
                "IdentityProviderFederation",
                "Licenses",
                "GeneralSettings",
                "PermissionGroups"
            ],
            "requestedBy": "planner@board.com",
            "date": "2025-03-13T20:25:20.933+00:00"
        }
    ]
}

    CEF response example

    CEF:0|Security|PermissionGroupManager|1.0|100|PERMISSION_GROUP_CREATED|10|id=8b78dbc6-37e6-49ba-8c5e-08dd626cfb0b name=TEST NEW GROUP authenticationType=Board authentication office=False mobile=False isDefault=False groupMetadataValues=[] requestedBy=planner@board.com platformAuthorizations=[{"Role":"admin","Platform":"board-api.board.com","License":"Developer","IsAdmin":true}] subscriptionHubAuthorizationsDefined=True subscriptionHubAuthorizations=["Users","UsersMetadata","SignInPage","Enrollment","Collaboration","IdentityProviderFederation","Licenses","GeneralSettings","PermissionGroups"] start=2025-03-13T20:23:56Z

    Folder Profiles API

    The "folderprofiles" API endpoint allows retrieval from the log of maintenance events on Capsule Folder Profiles for a specific date-time range. The API employs the POST method to send a request with the API parameters encapsulated in the body.

    Parameters

    This API only accepts and requires a date-time range as the mandatory parameter to restrict the size of the data set returned, either with start and end date-times, or as a "most recent" time duration.

    Start and end dates must be in ISO 8601 format, or the duration must be expressed as an integer number of days (d), hours (h), minutes (m) or seconds (s).

    Submission method: POST

    https://board-api.board.com/api/v1/log/folderprofiles

    Parameter examples

    { "startDate":"2025-01-01T07:35:00Z", "endDate":"2025-04-18T23:38:00Z" }
{ "timeDuration":"18h" }
{ "timeDuration":"100m" }

    Curl example

    curl --location 'https://board-api.board.com/api/v1/log/folderprofiles' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••' \
--data '{
       "timeDuration":"180d"
}'

    JSON request schema

    {
  "openapi": "3.0.0",
  "info": {
    "title": "Audit Log API - Folder Profiles",
    "version": "1.0.0",
    "description": ""
  },
  "servers": [
    {
      "url": "board-api.board.com"
    }
  ],
  "paths": {
    "/api/v1/log/folderprofiles": {
      "parameters": [],
      "post": {
        "summary": "Folder Profiles",
        "parameters": [],
        "responses": {},
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "startDate": {
                    "type": "string",
                    "format": "date-time"
                  },
                  "endDate": {
                    "type": "string",
                    "format": "date-time"
                  }  }  }  }  }  }  }  }  }  }

    JSON response schema

    {
  "description": "Generated schema for Folder Profiles",
  "type": "object",
  "properties": {
    "logs": {
      "type": "array",
      "uniqueItems": true,
      "minItems": 1,
      "items": {
        "required": [
          "id",
          "name",
          "actionType",
          "platform",
          "requestedBy",
          "date" ],
        "properties": {
          "id": { "type": "string", "minLength": 1 },
          "name": { "type": "string", "minLength": 1 },
          "rules": {
            "type": "array",
            "uniqueItems": true,
            "minItems": 1,
            "items": {
              "required": [
                "accessLevel",
                "folder",
                "propagateAccessLevel" ],
              "properties": {
                "accessLevel": { "type": "string", "minLength": 1 },
                "folder": { "type": "string", "minLength": 1 },
                "propagateAccessLevel": { "type": "boolean" } } } },
          "actionType": { "type": "string", "minLength": 1 },
          "platform": { "type": "string", "minLength": 1 },
          "requestedBy": { "type": "string", "minLength": 1 },
          "date": { "type": "string", "minLength": 1 } } } } },
  "required": [ "logs" ]
}

    JSON response example

    {
    "logs": [
        {
            "id": "7b6aa186-3b0d-48bd-b1b3-0e8ffcaed32f",
            "name": "7b6aa186-3b0d-48bd-b1b3-0e8ffcaed32f",
            "rules": [
                {
                    "accessLevel": "PlayOnly",
                    "folder": "21779 - Folder 1",
                    "propagateAccessLevel": false
                },
                {
                    "accessLevel": "ReadOnly",
                    "folder": "Policydocuments",
                    "propagateAccessLevel": false
                },
                {
                    "accessLevel": "PlayOnly",
                    "folder": "basic\\mcdonalds",
                    "propagateAccessLevel": true
                }
            ],
            "actionType": "FOLDER_PROFILE_CREATED",
            "platform": "board-api.board.com",
            "requestedBy": "planner@board.com",
            "date": "2025-04-28T09:47:04.134+00:00"
        } ,
        {
            "id": "90f99e81-fdb2-4e85-9506-3b8395d912fa",
            "name": "90f99e81-fdb2-4e85-9506-3b8395d912fa",
            "rules": [],
            "actionType": "FOLDER_PROFILE_DELETED",
            "platform": "board-api.board.com",
            "requestedBy": "beginner@board.com",
            "date": "2025-03-05T13:20:59.482+00:00"
        },
        {
            "id": "90f99e81-fdb2-4e85-9506-3b8395d912fa",
            "name": "90f99e81-fdb2-4e85-9506-3b8395d912fa",
            "rules": [],
            "actionType": "FOLDER_PROFILE_UPDATED",
            "platform": "board-api.board.com",
            "requestedBy": "beginner@board.com",
            "date": "2025-03-05T13:20:51.623+00:00"
        }
    ]
}

    CEF response example

    CEF:0|Security|FolderProfileManager|1.0|100|FOLDER_PROFILE_CREATED|10|id=7b6aa186-3b0d-48bd-b1b3-0e8ffcaed32f name=7b6aa186-3b0d-48bd-b1b3-0e8ffcaed32f rules=[{"AccessLevel":"PlayOnly","Folder":"21779 - Folder 1","PropagateAccessLevel":false},{"AccessLevel":"ReadOnly","Folder":"Policydocuments","PropagateAccessLevel":false},{"AccessLevel":"PlayOnly","Folder":"basic\\mcdonalds","PropagateAccessLevel":true}] requestedBy=expert@board.com platform=board-api.board.com start=2025-04-28T09:47:04Z
CEF:0|Security|FolderProfileManager|1.0|100|FOLDER_PROFILE_DELETED|10|id=90f99e81-fdb2-4e85-9506-3b8395d912fa name=90f99e81-fdb2-4e85-9506-3b8395d912fa rules=[] requestedBy=expert@board.com platform=board-api.board.com start=2025-03-05T13:20:59Z
CEF:0|Security|FolderProfileManager|1.0|100|FOLDER_PROFILE_UPDATED|10|id=90f99e81-fdb2-4e85-9506-3b8395d912fa name=90f99e81-fdb2-4e85-9506-3b8395d912fa rules=[] requestedBy=expert@board.com platform=board-api.board.com start=2025-03-05T13:20:51Z

    Data Models API

    The "datamodels" API endpoint allows retrieval from the log of maintenance events on Data Models for a specific date-time range. The API employs the POST method to send a request with the API parameters encapsulated in the body.

    Parameters

    This API only accepts and requires a date-time range as the mandatory parameter to restrict the size of the data set returned, either with start and end date-times, or as a "most recent" time duration.

    Start and end dates must be in ISO 8601 format, or the duration must be expressed as an integer number of days (d), hours (h), minutes (m) or seconds (s).

    Submission method: POST

    https://board-api.board.com/api/v1/log/datamodels

    Parameter examples

    { "startDate":"2025-01-01T07:35:00Z", "endDate":"2025-04-18T23:38:00Z" }
{ "timeDuration":"18h" }
{ "timeDuration":"100m" }

    Curl example

    curl --location 'https://kong-testrc-api.board.com/api/v1/log/datamodels' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••' \
--data '{
    "timeDuration":"4800h"
}'

    JSON request schema

    {
  "openapi": "3.0.0",
  "info": {
    "title": " Audit Log API - Data Models",
    "version": "1.0.0",
    "description": ""
  },
  "servers": [
    {
      "url": "board-api.board.com"
    }
  ],
  "paths": {
    "/api/v1/log/datamodels": {
      "parameters": [],
      "post": {
        "summary": "Data Models",
        "parameters": [],
        "responses": {},
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "timeDuration": {
                    "type": "string"
                  }  }  }  }  }  }  }  }  }  }

    JSON response schema

    {
  "description": "Generated schema for Data Models",
  "type": "object",
  "properties": {
    "logs": {
      "type": "array",
      "uniqueItems": true,
      "minItems": 1,
      "items": {
        "required": [
          "dbName",
          "name",
          "dbAccessMode",
          "securitySystemMode",
          "customSelectionScript",
          "hasSelection",
          "actionType",
          "platform",
          "requestedBy",
          "date"
        ],
        "properties": {
          "dbName": { "type": "string" },
          "name": { "type": "string" },
          "dbAccessMode": { "type": "string" },
          "securitySystemMode": { "type": "string" },
          "customSelectionScript": { "type": "string" },
          "hasSelection": { "type": "boolean" },
          "userSelections": {
            "type": "array",
            "items": { "required": [], "properties": {} } },
          "selectBasedOnCubeList": {
            "type": "array",
            "items": { "required": [], "properties": {} } },
          "cubesProfiles": {
            "type": "array",
            "items": { "required": [], "properties": {} } },
          "actionType": { "type": "string", "minLength": 1 },
          "platform": { "type": "string" },
          "requestedBy": { "type": "string" },
          "date": { "type": "string", "minLength": 1 } } } } },
  "required": [ "logs" ]
}

    JSON response example

    {
    "logs": [
        {
            "dbName": "New Data Model TEST AUDIT",
            "name": "TEST AUDIT",
            "dbAccessMode": "Builder",
            "securitySystemMode": "Builder",
            "customSelectionScript": "@selection",
            "hasSelection": false,
            "userSelections": [],
            "selectBasedOnCubeList": [],
            "cubesProfiles": [
                {
                    "name": "V0001",
                    "cubeAccessMode": "Ok",
                    "accessBy": {
                        "logicalOperator": "AND",
                        "cubes": [
                            {
                                "cubeName": "V0001",  "lockNotZeroMode": false
                            }
                        ]
                    },
                    "lockedBy": {
                        "logicalOperator": "AND",  "cubes": []
                    }
                }
            ],
            "actionType": "DATABASE_PROFILE_CREATED",
            "platform": "board-api.board.com",
            "requestedBy": "planner@board.com",
            "date": "2025-04-03T15:17:31.112+00:00"
        },
        {
            "dbName": "DataEntry",
            "name": "",
            "dbAccessMode": "0",
            "securitySystemMode": "0",
            "customSelectionScript": "",
            "hasSelection": false,
            "userSelections": [],
            "selectBasedOnCubeList": [],
            "cubesProfiles": [],
            "actionType": "DATABASE_PROFILE_DELETED",
            "platform": "board-api.board.com",
            "requestedBy": "planner@board.com",
            "date": "2025-03-05T13:21:46.468+00:00"
        }
    ]
}

    CEF response example

    CEF:0|Security|DataModelManager|1.0|100|DATABASE_PROFILE_CREATED|10|dbName=New Data Model TEST AUDIT name=TEST AUDIT dbAccessMode=Builder securitySystemMode=Builder customSelectionScript=@selection hasSelection=False userSelections=[] selectBasedOnCubeList=[] cubesProfiles=[{"Name":"V0001","CubeAccessMode":"Ok","AccessBy":{"LogicalOperator":"AND","Cubes":[{"CubeName":"V0001","LockNotZeroMode":false}]},"LockedBy":{"LogicalOperator":"AND","Cubes":[]}}] requestedBy=planner@board.com platform=board-api.board.com start=2025-04-03T15:17:31Z
CEF:0|Security|DataModelManager|1.0|100|DATABASE_PROFILE_DELETED|10|dbName=DataEntry name= dbAccessMode=0 securitySystemMode=0 customSelectionScript= hasSelection=False userSelections=[] selectBasedOnCubeList=[] cubesProfiles=[] requestedBy=speto@board.com platform=board-api.board.com start=2025-03-05T13:21:46Z

    Roles API

    The "roles" API endpoint allows retrieval from the log of maintenance events on Roles for a specific date-time range. The API employs the POST method to send a request with the API parameters encapsulated in the body.

    Parameters

    This API only accepts and requires a date-time range as the mandatory parameter to restrict the size of the data set returned, either with start and end date-times, or as a "most recent" time duration.

    Start and end dates must be in ISO 8601 format, or the duration must be expressed as an integer number of days (d), hours (h), minutes (m) or seconds (s).

    Submission method: POST

    https://board-api.board.com/api/v1/log/roles

    Parameter examples

    { "startDate":"2025-01-01T07:35:00Z", "endDate":"2025-04-18T23:38:00Z" }
{ "timeDuration":"18h" }
{ "timeDuration":"100m" }

    Curl example

    curl --location 'https://kong-testrc-api.board.com/api/v1/log/roles' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••' \
--data '{
    "startDate":"2025-01-01T07:35:00Z",
    "endDate":"2025-04-18T23:38:00Z" 
}'

    JSON request schema

    {
  "openapi": "3.0.0",
  "info": {
    "title": " Audit Log API - Data Models",
    "version": "1.0.0",
    "description": ""
  },
  "servers": [
    {
      "url": "board-api.board.com"
    }
  ],
  "paths": {
    "/api/v1/log/roles": {
      "parameters": [],
      "post": {
        "summary": "Roles",
        "parameters": [
          {
            "name": "Accept",
            "in": "header",
            "required": false,
            "example": "application/json",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {},
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "startDate": {
                    "type": "string",
                    "format": "date-time"
                  },
                  "endDate": {
                    "type": "string",
                    "format": "date-time"
                  } } } } } } } } } }

    JSON response schema

    {
  "description": "Generated schema for Roles",
  "type": "object",
  "properties": {
    "logs": {
      "type": "array",
      "uniqueItems": true,
      "minItems": 1,
      "items": {
        "required": [
          "id",
          "actionType",
          "platform",
          "requestedBy",
          "date"
        ],
        "properties": {
          "id": { "type": "string", "minLength": 1 },
          "folderProfiles": {
            "type": "array",
            "items": { "required": [], "properties": {} } },
          "databaseProfiles": {
            "type": "array",
            "items": { "required": [], "properties": {} } },
          "userSelections": {
            "type": "array",
            "items": { "required": [], "properties": {} } },
          "actionType": { "type": "string", "minLength": 1 },
          "platform": { "type": "string", "minLength": 1 },
          "requestedBy": { "type": "string", "minLength": 1 },
          "date": { "type": "string", "minLength": 1 } } } } },
  "required": [ "logs" ]
}

    JSON response example

    {
    "logs": [
        {
            "id": "17061179-ab5b-4b9e-bef2-b3aec049553c",
            "folderProfiles": [],
            "databaseProfiles": [],
            "userSelections": [],
            "actionType": "ROLE_DELETED",
            "platform": "board-api.board.com",
            "requestedBy": "Administrator+3",
            "date": "2025-04-17T14:22:55.45+00:00"
        },
        {
            "id": "17061179-ab5b-4b9e-bef2-b3aec049553c",
            "folderProfiles": [],
            "databaseProfiles": [],
            "userSelections": [],
            "actionType": "ROLE_CREATED",
            "platform": "board-api.board.com",
            "requestedBy": "Administrator+3",
            "date": "2025-04-17T14:22:18.046+00:00"
        },
        {
            "id": "a2481409-b32f-4e0b-b843-cdb83c3d085a",
            "folderProfiles": [],
            "databaseProfiles": [],
            "userSelections": [],
            "actionType": "ROLE_UPDATED",
            "platform": "board-api.board.com",
            "requestedBy": "Administrator+3",
            "date": "2025-04-17T14:21:55.109+00:00"
        }
   ]
}

    CEF response example

    CEF:0|Security|RoleManager|1.0|100|ROLE_DELETED|10|id=17061179-ab5b-4b9e-bef2-b3aec049553c platform=board-api.board.com applicationProfile= folderProfiles=[] databaseProfiles=[] userSelections=[] start=2025-04-17T14:22:55Z
CEF:0|Security|RoleManager|1.0|100|ROLE_CREATED|10|id=17061179-ab5b-4b9e-bef2-b3aec049553c platform=board-api.board.com applicationProfile= folderProfiles=[] databaseProfiles=[] userSelections=[] start=2025-04-17T14:22:18Z
CEF:0|Security|RoleManager|1.0|100|ROLE_UPDATED|10|id=a2481409-b32f-4e0b-b843-cdb83c3d085a platform=board-api.board.com applicationProfile= folderProfiles=[] databaseProfiles=[] userSelections=[] start=2025-04-17T14:21:55Z

    Features API

    The "feature" API endpoint allows retrieval from the log of maintenance events on Application Profiles for a specific date-time range. The API employs the POST method to send a request with the API parameters encapsulated in the body.

    Parameters

    This API only accepts and requires a date-time range as the mandatory parameter to restrict the size of the data set returned, either with start and end date-times, or as a "most recent" time duration.

    Start and end dates must be in ISO 8601 format, or the duration must be expressed as an integer number of days (d), hours (h), minutes (m) or seconds (s).

    Submission method: POST

    https://board-api.board.com/api/v1/log/features

    Parameter examples

    { "startDate":"2025-01-01T07:35:00Z", "endDate":"2025-04-18T23:38:00Z" }
{ "timeDuration":"18h" }
{ "timeDuration":"100m" }

    Curl example

    curl --location 'https://board-api.board.com/api/v1/log/features' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••' \
--data '{
    "startDate":"2025-01-01T07:35:00Z",
    "endDate":"2025-04-18T23:38:00Z" 
}'

    JSON request schema

    {
  "openapi": "3.0.0",
  "info": {
    "title": " Audit Log API - Application Profiles (Features)",
    "version": "1.0.0",
    "description": ""
  },
  "servers": [
    {
      "url": "board-api.board.com"
    }
  ],
  "paths": {
    "/api/v1/log/features": {
      "parameters": [],
      "post": {
        "summary": "Features",
        "parameters": [
          {
            "name": "Accept",
            "in": "header",
            "required": false,
            "example": "application/cef",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {},
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "startDate": {
                    "type": "string",
                    "format": "date-time"
                  },
                  "endDate": {
                    "type": "string",
                    "format": "date-time"
                  } } } } } } } } } }

    JSON response schema

    {
  "description": "Generated schema for Features",
  "type": "object",
  "properties": {
    "logs": {
      "type": "array",
      "uniqueItems": true,
      "minItems": 1,
      "items": {
        "required": [
          "id",
          "name",
          "canExecuteSecurityCriticalProcedures",
          "denyLayoutDesigner",
          "denySelect",
          "denyExportAndPrint",
          "denyProcedureEditing",
          "allowCorporateIdentityDesign",
          "allowValet",
          "denySubscribeAndSendTo",
          "actionType",
          "platform",
          "requestedBy",
          "date" ],
        "properties": {
          "id": { "type": "string", "minLength": 1 },
          "name": { "type": "string", "minLength": 1 },
          "canExecuteSecurityCriticalProcedures": { "type": "boolean" },
          "denyLayoutDesigner": { "type": "boolean" },
          "denySelect": { "type": "boolean" },
          "denyExportAndPrint": { "type": "boolean" },
          "denyProcedureEditing": { "type": "boolean" },
          "allowCorporateIdentityDesign": { "type": "boolean" },
          "allowValet": { "type": "boolean" },
          "denySubscribeAndSendTo": { "type": "boolean" },
          "publicApiScopeDenied": {
            "type": "array",
            "items": { "required": [], "properties": {} } },
          "actionType": { "type": "string", "minLength": 1 },
          "platform": { "type": "string", "minLength": 1 },
          "requestedBy": { "type": "string", "minLength": 1 },
          "date": { "type": "string", "minLength": 1 } } } } },
  "required": [ "logs" ]
}

    JSON response example

    {
    "logs": [
        {
            "id": "92d6edf4-5794-4ccc-aca4-6433cb0c320d",
            "name": "TestFeaturesE2E_Delete",
            "canExecuteSecurityCriticalProcedures": true,
            "denyLayoutDesigner": true, "denySelect": true,
            "denyExportAndPrint": true, "denyProcedureEditing": true,
            "allowCorporateIdentityDesign": true,
            "allowValet": true,
            "denySubscribeAndSendTo": true,
            "publicApiScopeDenied": [],
            "actionType": "APPLICATION_PROFILE_DELETED",
            "platform": "board-api.board.com",
            "requestedBy": "Administrator+3",
            "date": "2025-04-17T14:00:37.225+00:00"
        },
        {
            "id": "92d6edf4-5794-4ccc-aca4-6433cb0c320d",
            "name": "TestFeaturesE2E_Create",
            "canExecuteSecurityCriticalProcedures": true,
            "denyLayoutDesigner": true, "denySelect": true,
            "denyExportAndPrint": true, "denyProcedureEditing": true,
            "allowCorporateIdentityDesign": true,
            "allowValet": true,
            "denySubscribeAndSendTo": true,
            "publicApiScopeDenied": [],
            "actionType": "APPLICATION_PROFILE_CREATED",
            "platform": "board-api.board.com",
            "requestedBy": "Administrator+3",
            "date": "2025-04-17T14:00:34.715+00:00"
        },
        {
            "id": "0b501980-a152-4406-a2cd-75e734d8ee2d",
            "name": "TestFeaturesE2E_Copy",
            "canExecuteSecurityCriticalProcedures": true,
            "denyLayoutDesigner": true, "denySelect": true,
            "denyExportAndPrint": true, "denyProcedureEditing": true,
            "allowCorporateIdentityDesign": true,
            "allowValet": true,
            "denySubscribeAndSendTo": true,
            "publicApiScopeDenied": [],
            "actionType": "APPLICATION_PROFILE_UPDATED",
            "platform": "board-api.board.com",
            "requestedBy": "Administrator+3",
            "date": "2025-04-17T14:00:20.343+00:00"
        } ] }

    CEF response example

    CEF:0|Security|FeatureManager|1.0|100|APPLICATION_PROFILE_DELETED|10|id=7e67042d-f5fa-411f-898e-353a7672d245 name=TestFeaturesE2E_Delete canExecuteSecurityCriticalProcedures=True denyLayoutDesigner=True denySelect=True denyExportAndPrint=True denyProcedureEditing=True allowCorporateIdentityDesign=True allowValet=True denySubscribeAndSendTo=True publicApiScopeDenied=System.Collections.Generic.List`1[System.String] requestedBy=Administrator+3 platform=board-api.board.com start=2025-03-13T08:14:57Z
CEF:0|Security|FeatureManager|1.0|100|APPLICATION_PROFILE_CREATED|10|id=7e67042d-f5fa-411f-898e-353a7672d245 name=TestFeaturesE2E_Delete canExecuteSecurityCriticalProcedures=True denyLayoutDesigner=True denySelect=True denyExportAndPrint=True denyProcedureEditing=True allowCorporateIdentityDesign=True allowValet=True denySubscribeAndSendTo=True publicApiScopeDenied=System.Collections.Generic.List`1[System.String] requestedBy=Administrator+3 platform=board-api.board.com start=2025-03-13T08:14:54Z
CEF:0|Security|FeatureManager|1.0|100|APPLICATION_PROFILE_UPDATED|10|id=91292eab-cb57-4422-a94a-c47f2049d784 name=TestFeaturesE2E_copy canExecuteSecurityCriticalProcedures=True denyLayoutDesigner=True denySelect=True denyExportAndPrint=True denyProcedureEditing=True allowCorporateIdentityDesign=True allowValet=True denySubscribeAndSendTo=True publicApiScopeDenied=System.Collections.Generic.List`1[System.String] requestedBy=Administrator+3 platform=board-api.board.com start=2025-03-13T08:14:38Z

    Full Audit API

    As well as the actions which can be retrieved through the seven other Audit Log APIs, there are audit log entries of system-related Actions which are only available through this “catch all” API. The API employs the POST method to send a request with the API parameters encapsulated in the body.

    Log Type

    Description

    User Metadata

    Log entries that record creating, updating and deleting custom user metadata. This includes events of the following action types: USER_METADATA_CREATED, USER_METADATA_UPDATED, USER_METADATA_DELETED

    Platforms

    Creating, updating, or deleting a Board platform. This includes events of the following action types: PLATFORM_CREATED, PLATFORM_UPDATED, PLATFORM_DELETED

    Settings updates

    Enrollments, database synchronization, collaboration tools. This includes events of the following action types: GENERAL_SETTINGS_UPDATED, ENROLLMENT_SETTINGS_UPDATED, COLLABORATION_SETTINGS_UPDATED, SYNC_TO_DB_SETTINGS_UPDATED

    Federation

    Creating, updating, or deleting federations made with the Board platform. This includes events of the following action types: FEDERATION_CREATED, FEDERATION_UPDATED, FEDERATION_DELETE

    Parameters

    This API accepts and requires a date-time range as a mandatory parameter to restrict the size of the data set returned, either with start and end date-times, or as a "most recent" time duration. Two additional parameters are optional, allowing the selection of ActionTypes and/or a text search string to filter the results.

    Start and end dates must be in ISO 8601 format, or the duration must be expressed as an integer number of days (d), hours (h), minutes (m) or seconds (s).

    The ActionType values for the seven other specific APIs are listed in the table at the top of this article.

    Submission method: POST

    https://board-api.board.com/api/v1/log/fullaudit

    Parameter examples

    { "startDate":"2025-01-01T07:35:00Z",  "endDate":"2025-04-18T23:38:00Z" }
{ "timeDuration":"18h" }
{ "timeDuration":"100m" }
{ "timeDuration":"48h", "searchInfo":"FAILED", "actionType":["LOGIN"] }
{ "timeDuration":"180d", "actionType":["USER_CREATED"] }curl --location 'https://board-api.board.com/api/v1/log/fullaudit' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••' \
\
--data '{
     "timeDuration":"15d",
     "actionType":["USER_DELETED"]
}'

    Curl example

    curl --location 'https://board-api.board.com/api/v1/log/fullaudit' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••' \
\
--data '{
     "timeDuration":"15d",
     "actionType":["USER_DELETED"]
}'

    JSON request schema

    {
  "openapi": "3.0.0",
  "info": {
    "title": "Audit Log API – Full Audit",
    "version": "1.0.0",
    "description": ""
  },
  "servers": [
    {
      "url": "board-api.board.com"
    }
  ],
  "paths": {    
    "/api/v1/log/fullaudit": {
      "parameters": [],
      "post": {
        "summary": "FullAudit",
        "parameters": [],
        "responses": {},
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "timeDuration": {
                    "type": "string",
                    "format": "color"
                  },
                  "startDate": {
                    "type": "string",
                    "format": "date-time"
                  },
                  "endDate": {
                    "type": "string",
                    "format": "date-time"
                  },
                  "searchInfo": {
                    "type": "string"
                  },
                  "actionType": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    } } } } } } } } } } }

    JSON response schema

    {
  "description": "Generated schema for Full Audit",
  "type": "object",
  "properties": {
    "logs": {
      "type": "array",
      "uniqueItems": true,
      "minItems": 1,
      "items": {
        "required": [ "ipAddress", "user", "actionType", "date" ],
        "properties": {
          "ipAddress": { "type": "string" },
          "user": { "type": "string" },
          "info": {
            "type": "object",
            "properties": {
              "RequestedBy": { "type": "string", "minLength": 1 },
              "Id": { "type": "string", "minLength": 1 },
              "DisplayName": { "type": "string", "minLength": 1 },
              "Username": { "type": "string", "minLength": 1 },
              "Email": { "type": "string", "minLength": 1 },
              "PlatformAuthorizations": {
                "type": "array",
                "uniqueItems": true,
                "minItems": 1,
                "items": {
                  "required": [ "Role", "Platform", "License", "IsAdmin" ],
                  "properties": {
                    "Role": { "type": "string", "minLength": 1 },
                    "Platform": { "type": "string", "minLength": 1 },
                    "License": { "type": "string", "minLength": 1 },
                    "IsAdmin": { "type": "boolean" } } } },
              "Disabled": { "type": "boolean" },
              "Authentication": { "type": "string", "minLength": 1 },
              "PhoneNumber": { "type": "string" },
			  "EmailConfirmed": { "type": "boolean" },
              "PasswordNeverExpires": { "type": "boolean" },
              "License": { "type": "string", "minLength": 1 },
              "PermissionGroup": { "type": "string" },
              "Culture": { "type": "string" },
              "Office": { "type": "boolean" },
              "Mobile": { "type": "boolean" },
              "MetadataValues": {
                "type": "array",
                "uniqueItems": true,
                "minItems": 1,
                "items": {
                  "required": [ "Name", "Value" ],
                  "properties": {
                    "Name": { "type": "string", "minLength": 1 },
                    "Value": { "type": "string" } } } },
              "SubscriptionHubAuthorizations": {
                "type": "array",
                "items": { "required": [], "properties": {} } },
              "CollaborationGroups": {
                "type": "array",
                "items": { "required": [], "properties": {} } } },
            "required": [
              "RequestedBy",
              "Id",
              "DisplayName",
              "Username",
              "Email",
              "PlatformAuthorizations",
              "Disabled",
              "Authentication",
              "PhoneNumber",
              "EmailConfirmed",
              "PasswordNeverExpires",
              "License",
              "PermissionGroup",
              "Culture",
              "Office",
              "Mobile",
              "MetadataValues",
              "SubscriptionHubAuthorizations",
              "CollaborationGroups" ] },
          "actionType": { "type": "string", "minLength": 1 },
          "date": { "type": "string", "minLength": 1 } } } } },
  "required": [ "logs" ]
}

    JSON response example

    {
     "logs":[
        {
            "ipAddress":"",
            "user":"",
            "info":{
                  "RequestedBy":"Administrator+3",
                  "Id":"15360090-a7b6-4290-ae69-424a7fd4eb90",
                  "DisplayName":null,
                  "Username":"demoTest",
                  "Email":null,
                  "PlatformAuthorizations":[],
                  "Disabled":false,
                  "Authentication":"",
                  "PhoneNumber":null,
                  "EmailConfirmed":false,
                  "PasswordNeverExpires":true,
                  "License":"",
                  "PermissionGroup":"",
                  "Culture":"",
                  "Office":false,
                  "Mobile":false,
                  "MetadataValues":[],
                  "SubscriptionHubAuthorizations":[],
                  "CollaborationGroups":[]},
                  "actionType":"USER_DELETED",
                  "date":"2025-04-29T17:34:19.135+00:00"}
] }

    CEF response example

    CEF:0|Security|AuditLogManager|1.0|100|USER_DELETED|10|start=2025-04-30T11:22:14Z info={"RequestedBy":"Administrator\u002B3","Id":"16f95397-d22b-420b-96cb-7267fbbd2a01","DisplayName":"Mr.Bean","Username":"explanner@board.com","Email":"explanner@board.com","PlatformAuthorizations":[{"Role":"admin","Platform":"board-api.board.com","License":
"Lite Plus","IsAdmin":false}],"Disabled":false,"Authentication":"Board authentication", "PhoneNumber":"","EmailConfirmed":false,"Pa

    Was this article helpful?
    What's Next