Admin Logs API
Gets a list of admin events.
Important: This is a beta version of the API and there may be breaking changes in future releases.
HTTP Request
The API is invoked as a GET request to the following endpoint:
https://<host-name>/api/vbeta/mgmt/admin-logs
where <host-name> has the following value depending on the environment:
- Sandbox:
admin.bindid-sandbox.io - Production:
admin.bindid.io - Production EU:
admin.eu.bindid.io
Request Header
| Header Name | Value |
|---|---|
Authorization | A valid bearer token (see Token API) |
Request Parameters
| Field | Description | Type |
|---|---|---|
fromTime | Required. Time from which admin events are retrieved (inclusive), in unix-epoch milliseconds. | Number |
toTime | Required. Time to which admin events are retrieved (exclusive), in unix-epoch milliseconds. The maximum value between the fromTime and toTime cannot be more than 30 days. | Number |
skip | Optional. Determines the number of events which are not retrieved, starting from the newest events. Allowed values are from 0 to 1000. When the field is not specified, the value defaults to 0. | Number |
take | Optional. Limits the number of events returned in a single response. Allowed values are from 1 to 500. When the field is not specified, the value defaults to 300. | Number |
credentialsId | Required. API credentials ID used to create the access token that authorizes this request. | String |
Request Example
GET /api/vbeta/mgmt/admin-logs?credentialsId=e0af915d.management_api_app.tid_1107f3e1.bindid.io&fromTime=1640667842000&toTime=1640697948000&skip=2&take=2
Authorization: Bearer q5fDE10-mlM4xEwl_UnhKjhvWOLHEbXqzJOYpGgxuB0
Response Headers
The response includes this HTTP header:
| Header Name | Value |
|---|---|
Content-Type | application/json |
Response Body
The JSON object in the body has the following structure:
| Field Name | Description | Type |
|---|---|---|
data | Object containing admin event information. | data |
status | Indicates call success. | String |
data Object
| Field Name | Description | Type |
|---|---|---|
count | The number of returned admin events. | Number |
events | Array containing the returned admin events. | Array of events |
total | The total number of admin events found during the specified timeframe (including events that were not retrieved). | Number |
events Object
| Field Name | Description | Type |
|---|---|---|
activityType | Indicates the type of event that was created (see activityType Values). | String |
adminEmail | Email address of the admin who created the event. | String |
clientIp | IP address of the device on which the event was created. | String |
data | Object containing event-specific data (see activityType Values). | data |
id | Unique event ID. | String |
sessionId | ID of the session during which the event was created. | String |
tenantId | ID of the tenant. | String |
timestamp | Time the event occurred, in unix-epoch milliseconds. | String |
activityType Values
| Value | Description | Event-specific data Object Fields |
|---|---|---|
administrator_block_user_device | An admin blocked a user’s device. | deviceId (string), the blocked device's ID; userId(string), the ID of the user who registered with the blocked device; allowAccess (Boolean), indicates the device is blocked. |
administrator_create_api_credential | An admin created a new API credential. | clientId (string), the new API credential ID. |
administrator_create_application | An admin created a new application. | appId (string), the new application's ID; appName (string), the new application's name. |
administrator_create_risk_rule | An admin created a new risk rule. | ruleType (string), the risk rule type. |
administrator_enter_tenant | An admin successfully logged in to a tenant or switched to a different tenant. | isTenantSwitch (Boolean), indicates when an admin switched to a different tenant. |
administrator_export_event_data | An admin exported multiple events in a csv file or a single event's raw data (JSON). | multipeEvents (Boolean), true when multiple events are exported in a csv file; flowId (string), ID of the exported event - only listed when a single event's raw data is exported. |
administrator_leave_tenant | An admin logged out from a tenant or switched to a different tenant. | isTenantSwitch (Boolean), indicates when an admin switched to a different tenant. |
administrator_remove_admin_account | An admin was removed. | email (string), the email address of the removed admin. |
administrator_remove_application | An admin removed an application. | appId (string), the removed application's ID; appName (string), the removed application's name. |
administrator_remove_risk_rule | An admin removed a risk rule. | ruleType (string), the risk rule type. |
administrator_revoke_api_credential | An admin revoked an API credential. | clientId (string), the revoked API credential ID. |
administrator_tenant_invitation | An admin email invitation was sent. | email (string), the email address to which the invitation was sent. |
administrator_tenant_invitation_status_approved | A new admin was approved. | |
administrator_update_application | An admin updated an application's settings. | diff (string), a diff representation of changes made to the application's settings. |
administrator_update_branding_authentication | An admin updated the branding of the authentication pages. | diff (string), a diff representation of changes made to the authentication branding. |
administrator_update_branding_email_template | An admin updated an email template. | diff (string), a diff representation of changes made to the email template. |
administrator_update_general_settings | An admin updated a tenant's settings. | diff (string), a diff representation of changes made to the tenant's settings. |
administrator_update_risk_rule | An administrator updated a risk rule. | diff (string), a diff representation of changes made to the rule. |
expired_invitation_consumption | An admin failed to log in because the email invitation expired. |
Response Example
HTTP/2 200
Content-Type: application/json
{
"status": "success",
"data": {
"total": 4,
"count": 2,
"events": [
{
"clientIp": "77.137.179.55",
"sessionId": "IpsH6WP0mQifKT4G-iKCrRLKhEJOWiXv;io2MsxL64j1UDKF+8qVuN6WnMS60Cbn0Gw0mzQwvvGo=",
"adminEmail": "admin@company.com",
"data": {
"appId": "5655b11d",
"appName": "My App"
},
"activityType": "administrator_create_application",
"tenantId": "5fa4fa3a-ae0f-4ffa-9679-378071427da7",
"timestamp": 1640687947893,
"id": "pM-fAH4BtuuHXu_mUHiI"
},
{
"clientIp": "77.137.179.55",
"sessionId": "IpsH6WP0mQifKT4G-iKCrRLKhEJOWiXv;io2MsxL64j1UDKF+8qVuN6WnMS60Cbn0Gw0mzQwvvGo=",
"adminEmail": "admin@company.com",
"data": {
"diff": " {\n clients: [\n {\n- name: \"\"\n+ name: \"My Client\"\n- state: null\n+ state: \"new\"\n- smartBannerConfig: null\n- fallbackAuthMethod: null\n+ fallbackAuthMethod: \"device_only\"\n }\n ]\n- description: null\n+ description: \"\"\n- isKycEnabled: null\n+ isKycEnabled: false\n }\n"
},
"activityType": "administrator_update_application",
"tenantId": "5fa4fa3a-ae0f-4ffa-9679-378071427da7",
"timestamp": 1640687967589,
"id": "pc-fAH4BtuuHXu_mnXhw"
}
]
}
}